v1

latestOpenAPI 3.0.12026-07-2433136135.1 KB

Manage POIs

Create Custom POI

The create <<glossary:Custom POI>> endpoint can be used to generate custom POIs by specifying the unique polygons to analyze.<br/> The <<glossary:Custom POI>> can be generated by either specifying the combination of centroid (lng, lat) and mile radius to draw the POI's area, or by using GEOJson which includes a list of all polygon GEO points (lng, lat).<br/> This endpoint runs duplication checks on each call in order to ensure that the same <<glossary:Custom POI>> is not created more than once. If a <<glossary:Custom POI>> is already created the return code will display a wrong request (http-code=400) specifying the previously created API ID.</br> Please be aware that creating custom POIs might take longer than 30 seconds, which falls within the timeout window. During such occurrences, the HTTP response code will be 202 (i.e., In progress), along with the apiId of the partially created POI. You can monitor the creation status by querying the <a href=Get Custom POI Info > Get Custom POI</a> endpoint.

post/v1/poi/custom-poi

Request body

namestring required

subCategorystring required

tagIdstring

The Id of the tag that the <<glossary:Custom POI>> is requested to be associated with. If no value is provided, the new POI will not be associated with any tag.

centroidnumber[]

List of 2 values that represents the GEO location of the POI center

radiusnumber float

Radius (in miles) with which the polygon is constructed when the center of the polygon is the centroid

Example request

{
  "name": "Some Custom POI Name",
  "subCategory": "Pizza Place",
  "tagId": "672be20c36e1d0ff18a13807",
  "centroid": [
    -78.519444,
    36.61636
  ],
  "polygon": [
    [
      -78.51961433887482,
      36.61628975092374
    ],
    [
      -78.51927638053894,
      36.61628975092374
    ],
    [
      -78.51927638053894,
      36.616430763747964
    ],
    [
      -78.51961433887482,
      36.616430763747964
    ],
    [
      -78.51961433887482,
      36.61628975092374
    ]
  ],
  "address": {
    "address": "301 Ranch Dr",
    "city": "Milpitas",
    "zipCode": "95035"
  }
}

Response

200 response

Example response

{
  "data": {
    "result": "SUCCESS",
    "name": "Name to be used to identify the <<glossary:Custom POI>>",
    "apiId": "complex:8d22ae197ee335c5074a67ff"
  }
}