POST Create Lookup

The lookup endpoint allows a new lookup request to be created. You can add Zones to different points of interest using the POI (Places of Interest) lookup. In few minutes, you can programmatically create Zones, complete with a Circular Geofence and a Custom Action for any geographical region.

URL to call

https://api.bluedotinnovation.com/1/poi/lookup

Content Type

The content type should be specified in the Content-Type HTTP header as “application/json”.

image

Content-Type: application/json

Parameters

No URL Parameters required. See example JSON below.

Key JSON fields

Name Required Data Type Description Format
customerApiKey String API key for the customer found in the Account Management tab of Point Access UI.
apiKey String API Key of the relevant app found in the Manage Apps section of the App and Beacon Management tab of Point Access UI.
type String Restricts the results to locations matching the specified type. (e.g.: bakery,restaurant ) The complete list of type can be found here.
keyword String A term to be matched against all content that Google has indexed for the location, including but not limited to name, type, and address, as well as customer reviews and other third-party content.

JSON request to create a lookup specifying a location

Name Required Data Type Description
location String

The location from where the POI data needs to be sourced from.

Location can only accept complete names, rather than abbreviations. (e.g.: New York instead of NY, New South Wales instead of NSW or United States instead of USA).

The lowest granularity of locations that can be requested is County for United States of America and United Kingdom or Local Government Association for Australia.

Example: JSON request

{
    "security": {
        "customerApiKey": "d851c260-9a31-11e5-b7e5-b8ca3a6b879d",
        "apiKey": "7e9a7d30-1f09-11e7-ad24-06a56cd124c5"
    },
    "content": {
        "location": "San Francisco, California, United States",
        "type": "restaurant",
        "keyword": "thai"
    }
}

Example: JSON response to request

{
    "url": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0",
    "location": "San Francisco, California, United States",
    "status": "draft",
    "searchesUsed": 0,
    "searchesRemaining": 100000,
    "ready": false,
    "keyword": "thai",
    "type": "restaurant",
    "executeUrl": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0/execute?customerApiKey=d851c260-9a31-11e5-b7e5-b8ca3a6b879d&apiKey=7e9a7d30-1f09-11e7-ad24-06a56cd124c5",
    "message": "Draft query ready.",
    "messageCode": 200
}

JSON request to create a lookup specifying an area

Name Required Data Type Description Format
area Object

The area object is where the search area parameters are provided.

center Object Coordinates for the center point of the circle.
latitude Number Latitude of the center of the circular area.
longitude Number Longitude of the center of the circular area.
radius Number Double value representing the radius of a circular area in meters.

Max value is 1000000 (1000 Kms).

type String The value which signifies the type of search area.

Currently, circle is the only type supported.

Example: JSON request

{
    "security": {
        "customerApiKey": "d851c260-9a31-11e5-b7e5-b8ca3a6b879d",
        "apiKey": "7e9a7d30-1f09-11e7-ad24-06a56cd124c5"
    },
    "content": {
        "area": {
            "center": {
                "latitude": -122.4006339,
                "longitude": 37.7919951
            },
            "radius": 10000,
            "type": "circle"
        },
        "type": "restaurant",
        "keyword": "thai"
    }
}

Example: JSON response to request

{
    "url": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0",
    "status": "draft",
    "searchesUsed": 0,
    "searchesRemaining": 100000,
    "ready": false,
    "keyword": "thai",
    "type": "restaurant",
    "executeUrl": "https://api.bluedotinnovation.com/1/poi/lookup/dbf9f6b0-3668-407e-87b5-ee5aba4e35a0/execute?customerApiKey=d851c260-9a31-11e5-b7e5-b8ca3a6b879d&apiKey=7e9a7d30-1f09-11e7-ad24-06a56cd124c5",
    "message": "Draft query ready.",
    "messageCode": 200
}

Next Step

Created by Bluedot DevOps on January 31, 2018

Start the discussion