GET Moving-Geofence API

The Get Moving Geofence API gives you a filtered list of moving-geofences.

GET Moving-Geofence API

GET https://api.roam.ai/v1/api/moving-geofence/

Query Parameters

Name	Type	Description
start_date	string	Date from when the geofences created to be fetched. E.g.- 2020-09-28
end_date	string	Date till when the data need to be returned. E.g.- 2020-09-29
geofence_id	string	Get the details of one geofence. E.g.- 5f73326ce5fc231ba4b253eb
page_number	integer	This field can be used for getting 10 entries at a time. If the response returns an empty list in the data field, it is safe to assume the pages are exhausted. E.g.- 1

Headers

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

200

{
    "status": true,
    "msg": "Success.",
    "code": 200,
    "data": {
        "next_page": null,
        "pages": 1,
        "prev_page": null,
        "account_id": "5bda16a2ea00845b3b419160",
        "project_id": "5bda16edea00845b3b419163",
        "users": [
            "5f520949e3872b0341bcf3e7",
            "5f520955e3872b0341bcf3e8"
        ],
        "geofences": [
            {
                "counts": {
                    "events": 0,
                    "users": 0
                },
                "id": "5f9801aeffb3fb0de55e863d",
                "geometry_type": "circle",
                "geometry_radius": 500,
                "is_enabled": true,
                "description": "testing geofence",
                "color_code": "ggggg",
                "tag": "border code",
                "is_deleted": false,
                "created_at": "2020-10-27T11:17:02.956",
                "updated_at": "2020-10-27T11:20:33.050",
                "only_once": true
            }
        ]
    }
}

Sample Request

curl --location --request GET 'https://api.roam.ai/v1/api/moving-geofence/?start_date=2020-10-27&end_date=2020-10-27&count=True' \
--header 'Api-Key: e566c098cc6b441a9c3453b6fcf76e88'