Get User Home Location API

This API will provide a list of insights with boundary coordinates of the location, last visit details, type and confidence for the user's home.

Get Home Insight API

GET https://api.roam.ai/v1/api/insights/home/

Query Parameters

Name	Type	Description
user_id	string	Get Home location for the user. E.g.- 5d9450ace47bae6d70064a9b

Headers

Name	Type	Description
Api-key	string	Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f

200

{
    "status": true,
    "msg": "Success.",
    "code": 200,
    "data": {
        "user_id": "5f30d339b36114713d8b610e",
        "app_id": "5ed0e627372279444054d310_2",
        "home": [
            {
                "id": "5f3fa9c6b361144e2fbb94fe",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                4.891497893193696,
                                52.353609136438145
                            ],
                            ...
                            ...
                            [
                                4.891816390473826,
                                52.353578324857374
                            ]                       
                        ]
                    ]
                },
                "last_visited": {
                    "id": "5f36a5529b3043b3240c2c92",
                    "coordinates": {
                        "type": "Point",
                        "coordinates": [
                            4.891546992613287,
                            52.353057861328125
                        ]
                    },
                    "accuracy": null,
                    "altitude": 1.3552925316616893,
                    "recorded_at": "2021-06-14T14:53:06.320",
                    "started_at": null,
                    "created_at": "2021-06-14T14:53:06.505"
                },
                "tz_offset": "+0200",
                "confidence": "Medium",
                "type": "home",
                "created_at": "2021-06-21T11:02:27.831"
            }
        ]
    }
}

Sample Request

curl --location --request GET 'https://api.roam.ai/v1/api/insights/home/?user_id=5f30d339b36114713d8b610e' \
--header 'Api-key: ee5b950fdf284474a8727409cd12bb3b'