All pages
Powered by GitBook
1 of 4

Insights API

Insights APIs are on demand for our enterprise customers. In case you want us to process your location data to know your users Home, Work and POIs, please reach out to our customer support.

Get User POIs APIGet User Home Location APIGet User Work Location API

Get User POIs API

This API will provide a list of insights with boundary coordinates of the location, last visit details, type and confidence for POIs frequently visited by the user.

Get POI Insight API

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

Query Parameters

Name
Type
Description

user_id

string

Get POIs for the user. E.g.- 5d9450ace47bae6d70064a9b

Headers

Name
Type
Description

Api-key

string

Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f

{
    "status": true,
    "msg": "Success.",
    "code": 200,
    "data": {
        "user_id": "5f30d339b36114713d8b610e",
        "app_id": "5ed0e627372279444054d310_2",
        "insights": [
            {
                "id": "5f3fa9c6b361144e2fbb9500",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                4.909168389987688,
                                52.3609200524679
                            ],
                            ...
                            ...
                            [
                                4.909486939963033,
                                52.360889240887005
                            ]
                        ]
                    ]
                },
                "last_visited": {
                    "id": "5f350a1a23c368e44d9a4854",
                    "coordinates": {
                        "type": "Point",
                        "coordinates": [
                            4.909168389987687,
                            52.36029052734375
                        ]
                    },
                    "accuracy": null,
                    "altitude": -1.8016777038574219,
                    "recorded_at": "2021-06-13T09:38:27.361",
                    "started_at": null,
                    "created_at": "2021-06-13T09:38:34.169"
                },
                "tz_offset": "+0200",
                "confidence": "Medium",
                "type": "road",
                "created_at": "2021-06-21T11:02:28.865"
            },
            {
                "id": "5f3fa9c6b361144e2fbb9501",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                4.893461598938197,
                                52.35548792356163
                            ],
                            [
                                4.893780109757986,
                                52.35545711198083
                            ],
                            ...
                            ...
                            [
                                4.894067441293753,
                                52.355367693412276
                            ]
                        ]
                    ]
                },
                "last_visited": {
                    "id": "5f3bc1fa118fe82b1a623744",
                    "coordinates": {
                        "type": "Point",
                        "coordinates": [
                            4.893461598938197,
                            52.3548583984375
                        ]
                    },
                    "accuracy": null,
                    "altitude": -2.023803234100342,
                    "recorded_at": "2021-06-16T16:23:16.131",
                    "started_at": null,
                    "created_at": "2021-06-18T11:56:42.142"
                },
                "tz_offset": "+0200",
                "confidence": "Medium",
                "type": "residential",
                "created_at": "2021-06-21T11:02:29.710"
            },
            {
                "id": "5f3fa9c6b361144e2fbb9502",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                4.891453618793093,
                                52.35234461301476
                            ],
                            ...
                            ...
                            [
                                4.891772106961156,
                                52.35231380143401
                            ]
                        ]
                    ]
                },
                "last_visited": {
                    "id": "5f38f7a9113938bc6862e138",
                    "coordinates": {
                        "type": "Point",
                        "coordinates": [
                            4.891453618793093,
                            52.351715087890625
                        ]
                    },
                    "accuracy": null,
                    "altitude": 1.5472954213619232,
                    "recorded_at": "2021-06-16T09:08:57.303",
                    "started_at": null,
                    "created_at": "2021-06-16T09:08:57.513"
                },
                "tz_offset": "+0200",
                "confidence": "Medium",
                "type": "house_number",
                "created_at": "2021-06-21T11:02:30.202"
            }
        ]
    }
}

Sample Request

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

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

{
    "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'

Get User Work 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 work.

Get Work Insight API

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

Query Parameters

Name
Type
Description

user_id

string

Get Work location for the user. E.g.- 5d9450ace47bae6d70064a9b

Headers

Name
Type
Description

Api-key

string

Auth-key E.g.- 33223kjhdcscijhb5sdbsdmjsdcbj5f

{
    "status": true,
    "msg": "Success.",
    "code": 200,
    "data": {
        "user_id": "5f30d339b36114713d8b610e",
        "app_id": "5ed0e627372279444054d310_2",
        "work": [
            {
                "id": "5f3fa9c6b361144e2fbb94ff",
                "geometry": {
                    "type": "Polygon",
                    "coordinates": [
                        [
                            [
                                4.907285075174389,
                                52.36281525332162
                            ],
                            ...
                            ...
                            [
                                4.907603638813551,
                                52.36278444174071
                            ]
                        ]
                    ]
                },
                "last_visited": {
                    "id": "5f3bc1fc118fe82b1a623751",
                    "coordinates": {
                        "type": "Point",
                        "coordinates": [
                            4.907237518324856,
                            52.36199951171875
                        ]
                    },
                    "accuracy": null,
                    "altitude": -0.5668405294418335,
                    "recorded_at": "2021-06-17T08:31:24.594",
                    "started_at": null,
                    "created_at": "2021-06-18T11:56:44.237"
                },
                "tz_offset": "+0200",
                "confidence": "Medium",
                "type": "work",
                "created_at": "2021-06-21T11:02:28.295"
            }
        ]
    }
}

Sample Request

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