API Documentation

API Documentation

1.0.0

Analytics

Analytics | Get credentials to real time data.

Get credentials to real time data. You can find a client library on https://socket.io/. Here is example code of possible integration https://goo.gl/KLjein

get 
https://cloud.estimote.com/v3/analytics/real-time/room

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/analytics/real-time/room' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN
HTTP/1.1 200 OK
{
   "data": {
     "room_id": "YOUR_PRIVATE_ROOM_ID",
     "url": "https://estimote-analytics.herokuapp.com",
     "path": "/real-time-analytics"
   }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Analytics | Get unique visitors breakdown

Returns the number of unique visitors broken down by one of the following dimensions - application, location or tag

get 
https://cloud.estimote.com/v3/analytics/visitors/total

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/visitors/total?from=1448928000&to=1451606399&group_by=location' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN
curl 'https://cloud.estimote.com/v3/analytics/visitors/total?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
group_by optional String

Dimension by which the data is broken down

Allowed values: "application", "location", "tag"

Success 200

Field Type Description
data Array
  key Date

Human-readable name of the entity for which data is reported, i.e. tag name, application name, or street address of the location
  count Number

Number of unique visitors

 
HTTP/1.1 200 OK
{
  "data": [{
    "key": "Healthcare",
    "count": 63
  }, {
    "key": "Meat",
    "count": 23
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get unique visitors distribution

Returns the hourly distribution of visitors in a week. Every hour of the week is assigned to one of the 9 buckets, depending on the number of unique visitors.

get 
https://cloud.estimote.com/v3/analytics/visitors/distribution

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/visitors/distribution?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)

Success 200

Field Type Description
data Array
  wday Number

Number of day (0 is Sunday)
  buckets Array
    wday Number

Day number
    hour Number

Hour
    visitors Number

Number of unique visitors in the particular hour of the week over the period defined by the "from" and "to" parameters.
    bucket Number

Bucket number, reflecting the relative number of visitors who had visited your locations in the particular hour of the week.

 
HTTP/1.1 200 OK
{
  "data": [{
    "wday": 0,
    "buckets": [{
      "wday": 0,
      "hour": 0,
      "visitors": 1,
      "bucket": 1
    }]
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get unique visitors

Returns the number of unique visitors in the specified period broken down by the value of the granularity parameter.

get 
https://cloud.estimote.com/v3/analytics/visitors

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/visitors?from=1448928000&to=1451606399&granularity=daily' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
granularity String

Period over which the uniqueness of visitor is considered

Allowed values: "hourly", "daily", "weekly", "monthly"

Success 200

Field Type Description
data Array
  date Date

Starting date of the period for which data is reported. Length of the period is equal to the value of the "granularity" parameter.
  count Number

Number of unique visitors

 
HTTP/1.1 200 OK
{
  "data": [{
    "date": "2016-02-22",
    "count": 166
  }, {
    "date": "2016-02-23",
    "count": 157
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visit duration breakdown

Returns visit duration broken down by one of the following dimensions - application, location or tag

get 
https://cloud.estimote.com/v3/analytics/duration/total

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/duration/total?from=1448928000&to=1451606399&group_by=location' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN
curl 'https://cloud.estimote.com/v3/analytics/duration/total?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
group_by optional String

Dimension by which the data is broken down

Allowed values: "application", "location", "tag"

Success 200

Field Type Description
data Array
  key Date

Human-readable name of the entity for which data is reported, i.e. tag name, application name, or street address of the location
  count Number

Visit duration in seconds

 
HTTP/1.1 200 OK
{
  "data": [{
    "key": "Healthcare",
    "count": 1050
  }, {
    "key": "Meat",
    "count": 900
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visit duration distribution

Returns the distribution of visit duration over the specified period. Data buckets are calculated automatically by Estimote Cloud.

get 
https://cloud.estimote.com/v3/analytics/duration/distribution

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/duration/distribution?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)

Success 200

Field Type Description
data Array
  avg Number

Average dwell time of visit in seconds
  count Array

Number of visits in specified range
  bucket Number

Bucket number
  range Number

Range of bucket in seconds

 
HTTP/1.1 200 OK
{
  "data": [{
    "avg": 86.05300859598854,
    "count": "698",
    "bucket": 1,
    "range": [0, 120]
  }, {
    "avg": 193.0225641025641,
    "count": "975",
    "bucket": 2,
    "range": [120, 300]
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visit duration for device.

Get visits duration for specific device.

get 
https://cloud.estimote.com/v3/analytics/devices/:identifier/duration

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/analytics/devices/DEVICE_IDENTIFIER/duration?granularity=weekly' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from optional Number
  • Beginning of the reporting period (Unix timestamp)
to optional Number
  • End of the reporting period (Unix timestamp)
granularity optional String
  • Granularity of returning data

Allowed values: "hourly", "daily", "weekly", "monthly" 

HTTP/1.1 200 OK
{
    "meta": {
        "total": 0,
        "from": "1504623467",
        "to": "1507042667",
        "granularity": "monthly"
    },
    "data": [
        {
            "date": "2017-09-01",
            "count": 0
        },
        {
            "date": "2017-10-01",
            "count": 0
        }
    ]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "granularity",
      path: "query.granularity",
      title: "granularity is not valid",
      message: "\"granularity\" must be one of [monthly, weekly, hourly, daily]",
    }
  ]
}

Analytics | Get most visited devices from location.

Get visits duration for specific device.

get 
https://cloud.estimote.com/v3/analytics/devices/most_visited

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/analytics/devices/most_visited?location_id=1&limit=2' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from optional Number
  • Beginning of the reporting period (Unix timestamp)
to optional Number
  • End of the reporting period (Unix timestamp)
location_id optional Number
  • Fetch only devices that belong to this location id
limit optional Number
  • Number of records to return

Default value: 5

 
HTTP/1.1 200 OK
{
   "meta": {
       "location_id": 1
   },
   "data": [
       {
           "device_identifier": "d7f7a422ee6d4840a4d25c29de393d25",
           "visits": 40,
           "name": "beacon 1",
           "form_factor": "standard",
           "color": "ice"
       },
       {
           "device_identifier": "d1524c45e6e1b16330e38d9182603b04",
           "visits": 38,
           "name": "beacon 2",
           "form_factor": "standard",
           "color": "blueberry"
       }
   ]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "location_id",
      path: "query.location_id",
      title: "location_id is not valid",
      message: "\"location_id\" must be a number",
    }
  ]
}

Analytics | Get visit duration

Returns the visit duration averaged over the "granularity" period. Returns data for the time span defined by the "from" and "to" parameters.

get 
https://cloud.estimote.com/v3/analytics/duration

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/duration?from=1448928000&to=1451606399&granularity=daily' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
granularity String

Period over which visit duration is averaged

Allowed values: "hourly", "daily", "weekly", "monthly"

Success 200

Field Type Description
data Array
  date Date

Starting date of the period for which data is reported. Length of the period is equal to the value of the "granularity" parameter.
  count Number

Average visit duration in seconds

 
HTTP/1.1 200 OK
{
  "data": [{
    "date": "2016-02-22",
    "count": 1050
  }, {
    "date": "2016-02-23",
    "count": 900
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visitor loyalty breakdown

Returns visitor loyalty information for one of the following dimensions - application, location or tag

get 
https://cloud.estimote.com/v3/analytics/loyalty/total

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/loyalty/total?from=1448928000&to=1451606399&group_by=location' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
group_by optional String

Dimension by which the data is broken down

Allowed values: "application", "location", "tag"

Success 200

Field Type Description
data Array
  tag_id Number

Internal tag id
  name String

Tag name
  location_id Number

Internal location id
  formatted_address String

Complete street address of the location
  visits Number

Number of visits made to beacons at the given location or tagged with the given tag
  buckets Array
    bucket Number

Number of the bucket, which indicates visitors' loyalty, i.e. is equal to the number of visits they made in the given period. Bucket no. 7 contains all the visitors who made 7 or more visits.
    tag_id Number

Internal tag id
    location_id Number

Internal location id
    visitors_pct Number

Percentage of visitors who belong to the given loyalty bucket.
    visits Number

Number of visits made by the visitors who belong to the given loyalty bucket.

 
{
    "data": [
        {
            "tag_id": 2374,
            "name": "Cameras",
            "visits": 1686,
            "buckets": [
                {
                    "tag_id": 2374,
                    "bucket": 1,
                    "visits": 863,
                    "visitors_pct": 76.04
                },
                {
                    "tag_id": 2374,
                    "bucket": 2,
                    "visits": 338,
                    "visitors_pct": 14.89
                }
            ]
        }
    ]
}
{
    "data": [
        {
            "location_id": 761,
            "formatted_address": "35 E 19th St, New York, NY 10003, USA",
            "visits": 1686,
            "buckets": [
                {
                    "location_id": 761,
                    "bucket": 1,
                    "visits": 863,
                    "visitors_pct": 76.04
                },
                {
                    "location_id": 761,
                    "bucket": 2,
                    "visits": 338,
                    "visitors_pct": 14.89
                }
            ]
        }
    ]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visitor loyalty

Returns visitor loyalty information. Visitors are grouped in buckets, depending on the number of visits they made in the given period.

get 
https://cloud.estimote.com/v3/analytics/loyalty

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/loyalty?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)

Success 200

Field Type Description
data Array
  bucket Date

Number of the bucket indicates visitors' loyalty, i.e. is equal to the number of visits they made in the given period. Bucket no. 7 contains all the visitors who made 7 or more visits.
  visitors Number

Number of unique visitors who belong to the given loyalty bucket
  visits Number

Number of visits made by the visitors who belong to the given loyalty bucket
  total_visitors Number

Total number of visitors
  total_visits Number

Total number of visits
  visitors_pct Number

Percentage of visitors who belong to the given loyalty bucket
  visits_pct Number

Percentage of visits made by the visitors who belong to the given loyalty bucket

 
HTTP/1.1 200 OK
{
  "data": [{
    "bucket": 1,
    "range": [
      [],
      []
    ],
    "visitors": "2352",
    "visits": 2352,
    "total_visitors": 3352,
    "total_visits": 5451,
    "visitors_pct": 70.17,
    "visits_pct": 43.15
  }, {
    "bucket": 2,
    "range": [
      [],
      []
    ],
    "visitors": "583",
    "visits": 1166,
    "total_visitors": 3352,
    "total_visits": 5451,
    "visitors_pct": 17.39,
    "visits_pct": 21.39
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visitors for device.

Get visitors in range of specific device.

get 
https://cloud.estimote.com/v3/analytics/devices/:identifier/visitors

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/analytics/devices/DEVICE_IDENTIFIER/visitors?granularity=weekly' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from optional Number
  • Beginning of the reporting period (Unix timestamp)
to optional Number
  • End of the reporting period (Unix timestamp)
granularity optional String
  • Granularity of returning data

Allowed values: "hourly", "daily", "weekly", "monthly" 

HTTP/1.1 200 OK
{
    "meta": {
        "total": 2,
        "from": "1415300000",
        "to": "1415831441",
        "granularity": "weekly"
    },
    "data": [
        {
            "date": "2014-11-03",
            "count": 2
        },
        {
            "date": "2014-11-09",
            "count": 0
        }
    ]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 

HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "granularity",
      path: "query.granularity",
      title: "granularity is not valid",
      message: "\"granularity\" must be one of [monthly, weekly, hourly, daily]",
    }
  ]
}

Analytics | Get visitors for device.

Get visitors in range of specific device.

get 
https://cloud.estimote.com/v3/analytics/devices/:identifier/loyalty

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/analytics/devices/DEVICE_IDENTIFIER/loyalty' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from optional Number
  • Beginning of the reporting period (Unix timestamp)
to optional Number
  • End of the reporting period (Unix timestamp)
 
HTTP/1.1 200 OK
{
    "meta": {
        "total": 1,
        "from": "1415300000",
        "to": "1417719200"
    },
    "data": [
        {
            "bucket": 1,
            "range": "[1,2)",
            "visitors": 2,
            "visits": 2,
            "total_visitors": 2,
            "total_visits": 2,
            "visitors_pct": 100,
            "visits_pct": 100
        }
    ]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "granularity",
      path: "query.granularity",
      title: "query is not valid",
      message: "\"granularity\" is not allowed",
    }
  ]
}

Analytics | Get visits breakdown

Returns analytics data broken down by one of the following dimensions - application, location or tag. Breakdown by tag can be used to track visits to particular departments or aisles, therefore a new visit will be started if the visitor stays out of range of tagged beacons of over 20 minutes.

get 
https://cloud.estimote.com/v3/analytics/visits/total

Permission: public 

curl 'https://cloud.estimote.com/v3/analytics/visits/total?from=1448928000&to=1451606399&group_by=location' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN
curl 'https://cloud.estimote.com/v3/analytics/visits/total?from=1448928000&to=1451606399' -X GET -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)
group_by optional String

Dimension by which the data is broken down

Allowed values: "application", "location", "tag"

Success 200

Field Type Description
data Array
  key Date

Human-readable name of the entity for which data is reported, i.e. tag name, application name, or street address of the location
  frequency Number

Average number of visits per visitor for the given entity
  avg_duration Number

Average visit duration in seconds for the given entity
  count Number

Number of visits for the given entity
  visitors Number

Number of unique visitors for the given entity
  new_visitors_pct Number

Percentage of new visitors, i.e. visitors who made just one visit in the reporting period.

 
HTTP/1.1 200 OK
{
  "data": [{
    "tag_id": 2374,
    "key": "Beauty",
    "frequency": 1.4840989399293285,
    "avg_duration": 395.27,
    "count": 1680,
    "visitors": 1132,
    "new_visitors_pct": 75.97
  }]
}
HTTP/1.1 200 OK
{
  "data": [{
    "location_id": 715,
    "key": "35 E 19th St., New York, NY 10003, USA",
    "frequency": 1.4840989399293285,
    "avg_duration": 395.27,
    "count": 1680,
    "visitors": 1132,
    "new_visitors_pct": 75.97
  }]
}
HTTP/1.1 200 OK
{
  "data": [{
    "application_id": "demo-app-6gd",
    "key": "Estimote Demo App",
    "frequency": 1.4840989399293285,
    "avg_duration": 395.27,
    "count": 1680,
    "visitors": 1132,
    "new_visitors_pct": 75.97
  }]
}
HTTP/1.1 200 OK
[
  {
    "total":"93"
  }
]

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visits distribution

Returns the hourly distribution of visits in a week. Every hour of the week is assigned to one of the 9 buckets, depending on the number of visits.

get 
https://cloud.estimote.com/v3/analytics/visits/distribution

Permission: public 

curl 'https://cloud.estimote.com/v2/analytics/visits/distribution?from=1448928000&to=1451606399' -X GET  -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from Number

Beginning of the reporting period (Unix timestamp)
to Number

End of the reporting period (Unix timestamp)

Success 200

Field Type Description
data Array
  wday Number

Number of day (0 is Sunday)
  buckets Array
    wday Number

Day number
    hour Number

Hour
    visits Number

Number of visits in the particular hour of the week, over the period defined by the "from" and "to" parameters.
    bucket Number

Bucket number, reflecting the relative number of visits to your locations in the particular hour of the week.

 
HTTP/1.1 200 OK
{
  "data": [
  {
    "wday": 0,
    "buckets": [{
      "wday": 0,
      "hour": 0,
      "visits": 21,
      "bucket": 1
    }]
  },
  {
    "wday": 0,
    "buckets": [{
      "wday": 0,
      "hour": 1,
      "visits": 15,
      "bucket": 1
    }]
  },
  ...
  {
    "wday": 6,
    "buckets": [{
      "wday": 6,
      "hour": 0,
      "visits": 3,
      "bucket": 1
    },
    ...
    {
      "wday": 6,
      "hour": 23,
      "visits": 10,
      "bucket": 1
    }]
  }
  ]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
400_Bad_Request

Make sure all the required parameters have been provided in the query string.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists.

Analytics | Get visits for device.

Get visits in range of specific device.

get 
https://cloud.estimote.com/v3/analytics/devices/:identifier/visits

Permission: public 

curl -X GET 'https://cloud.estimote.com//v3/analytics/devices/DEVICE_IDENTIFIER/visits' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query Parameter

Field Type Description
from optional Number
  • Beginning of the reporting period (Unix timestamp)
to optional Number
  • End of the reporting period (Unix timestamp)
granularity optional String
  • Granularity of returning data

Allowed values: "hourly", "daily", "weekly", "monthly" 

HTTP/1.1 200 OK
{
  "meta": {
    "total": 0,
    "from": "1504623110",
    "to": "1507042310",
    "granularity": "daily"
  },
  "data": [
    {
      "date": "2017-09-05",
      "count": 0
    },
    {
      "date": "2017-09-06",
      "count": 0
    },
    {
      "date": "2017-09-07",
      "count": 0
    }
  ]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "granularity",
      path: "query.granularity",
      title: "granularity is not valid",
      message: "\"granularity\" must be one of [monthly, weekly, hourly, daily]",
    }
  ]
}

Applications

Applications | Create new Application

Creates a new application. ID is automatically generated based on a name, eg. "My Cool App" results in "my-cool-app" id.

post 
https://cloud.estimote.com/applications

Request body

Field Type Description
name String

Application Name.
source String

Application Type. Should be either "web" or "sdk"

 
HTTP/1.1 200 OK
{
  "status": "ok"
}

401

Name Description
serverError

Unauthorized

422

Name Description
serverError

Name taken

500

Name Description
serverError

Error during processing request

Applications | Remove Application

Removes an application. Keep in mind that any apps using its ID and Token will probably stop working.

delete 
https://cloud.estimote.com/applications/:id

URL Parameter

Field Type Description
id String

Application ID

 
HTTP/1.1 200 OK
{
  "status": "ok"
}

401

Name Description
serverError

Unauthorized

403

Name Description
serverError

Forbidden

404

Name Description
serverError

App not found

500

Name Description
serverError

Error during processing request

Applications | Reset Token for Application

Changes given applications's token to randomly generated new one.

post 
https://cloud.estimote.com/applications/:id/reset

URL Parameter

Field Type Description
id String

Application ID

Success 200

Field Type Description
token String

New token

 
HTTP/1.1 200 OK
{
  "token": "c0ntextI$k1ng"
}

500

Name Description
serverError

Error during processing request

Applications | Update Application

Updates an application.

patch 
https://cloud.estimote.com/applications/:id

URL Parameter

Field Type Description
id String

Application ID

Request body

Field Type Description
name String

Application Name.
source String

Application Type. Should be either "web" or "sdk"

 
HTTP/1.1 200 OK
{
  "name": "app_0ixviv9zc7"
  "readable_name": "Nananananan"
  "source": "web"
  "token": "9334659f7058b61f9a3ca12297848a7b"
}

401

Name Description
serverError

Unauthorized

404

Name Description
serverError

App not found

422

Name Description
serverError

Name taken

500

Name Description
serverError

Error during processing request

Attachments

Attachments | Create attachment

Creates a new attachment

post 
https://cloud.estimote.com/v3/attachments

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/attachments' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json" -d '{"data": {"payload": {"key1": "1","key2": "text"},"identifier": "YOUR_DEVICE_IDENTIFIER","for": "device"}}'
{
    "data": {
        "payload": {
            "key1": "1",
            "key2": "text"
        },
        "identifier": "YOUR_DEVICE_IDENTIFIER",
        "for": "device"
    }
}
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
     "id": 1,
     "created_at": "2017-10-06 14:24:00",
     "updated_at": "2017-10-06 14:24:00",
     "payload": {
       "key1": "1",
       "key2": "text"
     },
     "identifier": "YOUR_DEVICE_IDENTIFIER",
     "for": "device"
 }
}

Client Errors

Name Description
400_Bad_Request

Attachment for identifier already exists
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
403_Forbidden

Not enough permission to create requested attachment.
404_Not_Found

Identifier/for combination does not exist or does not belong to authenticated user

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 404 Not Found
{
  errors: [
    {
      status: 404,
      code: "Not Found",
      message: "Identifier/for combination does not exist or does not belong to authenticated user"
    }
  ]
}

Attachments | Delete attachment

Deletes an attachment

delete 
https://cloud.estimote.com/v3/attachments/:id

Permission: public 

curl -X DELETE 'https://cloud.estimote.com/v3/attachments/ATTACHMENT_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
     "id": ATTACHMENT_ID,
     "created_at": "2017-10-06 14:24:00",
     "updated_at": "2017-10-06 14:24:00",
     "payload": {
       "beacons": "estimote",
       "cool": "true"
     }
     "identifier": "YOUR_DEVICE_IDENTIFIER",
     "for": "device"
 }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
404_Not_Found

Attachment with given id does not exist or does not belong to authenticated user

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 404 Not Found
{
  errors: [
    {
      status: 404,
      code: "Not Found",
      message: "Attachment with given id does not exist or does not belong to authenticated user"
    }
  ]
}

Attachments | Get attachment

Gets an attachment by id

get 
https://cloud.estimote.com/v3/attachments/:id

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/attachments/ATTACHMENT_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
     "id": ATTACHMENT_ID,
     "created_at": "2017-10-06 14:24:00",
     "updated_at": "2017-10-06 14:24:00",
     "payload": {
       "key1": "1",
       "key2": "text"
     },
     "identifier": "YOUR_DEVICE_IDENTIFIER",
     "for": "device"
 }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
404_Not_Found

Attachment with given id does not exist or does not belong to authenticated user

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 404 Not Found
{
  errors: [
    {
      status: 404,
      code: "Not Found",
      message: "Attachment with given id does not exist or does not belong to authenticated user"
    }
  ]
}

Attachments | Get attachments

Get attachments

get 
https://cloud.estimote.com/v3/attachments

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/attachments' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/attachments?fields=id&fields=payload&payload==%7B%22key2%22:%22text%22%7D&for=device&identifiers=YOUR_DEVICE_IDENTIFIER_1%2CYOUR_DEVICE_IDENTIFIER_2' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Query Parameter

Field Type Description
fields optional String

comma-separated list of fields for projection, allowed: ["id","created_at","updated_at","payload","identifier","for"]
identifiers optional String

comma-separated list of identifiers
for optional String

if provided will return results for given type

Default value: device
payload optional String

JSON as string - if provided will return results where payload matches given payload
page optional Integer

page number for pagination (page size=100)

Default value: 1

 
HTTP/1.1 200 OK
{
  "meta": {
   "total_count": 2,
   "page": 1
  },
  "data":[
   {
     "id": 1,
     "created_at": "2017-10-06 14:24:00",
     "updated_at": "2017-10-06 14:24:00",
     "payload": {
       "key1": "1",
       "key2": "text"
     },
     "identifier": "YOUR_DEVICE_IDENTIFIER_1",
     "for": "device"
   },
   {
     "id": 2,
     "created_at": "2017-10-06 14:27:00",
     "updated_at": "2017-10-06 14:27:00",
     "payload": {
       "key1": "1",
       "desk": "mint",
       "venue": "NYC"
     },
     "identifier": "YOUR_DEVICE_IDENTIFIER_2",
     "for": "device"
   },
 ]
}
HTTP/1.1 200 OK
{
  "meta": {
   "total_count": 1,
   "page": 1
  },
  "data":[
   {
     "id": 1,
     "payload": {
       "key1": "1",
       "key2": "text"
     }
   }
 ]
}

Client Errors

Name Description
400_Bad_Request

Invalid query arguments provided
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 401 Unauthorized
{
  errors: [
    {
      status: 401,
      code: "Unauthorized",
      message: "Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps"
    }
  ]
}

Attachments | Get device attachment

Get device's attachment.

get 
https://cloud.estimote.com/v3/devices/:identifier/attachment

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/40b334d1d6e81be37d0dd85b9b9f373c/attachment' -H "Accept: application/json"

Query Parameter

Field Type Description
for optional String

if provided will return results for given type, allowed

Default value: device

 
HTTP/1.1 200 OK
{
  meta: {},
  data: {
    "id": 219,
    "for": "device",
    "identifier": "YOUR_DEVICE_IDENTIFIER",
    "public": false,
    "payload": {
        "attachment": "cool"
    },
    "created_at": "2018-04-27T09:32:31.478Z",
    "updated_at": "2018-04-27T09:32:31.478Z"
  }
}

Client Errors

Name Description
400_Bad_Request

Incorrect request format
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
404_Not_Found

Device does not belong to the authenticated user

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

Attachments | Update attachment payload

Updates attachment's payload

patch 
https://cloud.estimote.com/v3/attachments/:id

Permission: public 

curl -X PATCH 'https://cloud.estimote.com/v3/attachments/ATTACHMENT_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json" -d '{"data":{"payload":{"beacons":"estimote","cool":"true"}}}'
{
    "data": {
        "payload": {
            "beacons": "estimote",
            "cool": "true"
        }
    }
}
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
     "id": ATTACHMENT_ID,
     "created_at": "2017-10-06 14:24:00",
     "updated_at": "2017-10-06 14:24:00",
     "payload": {
       "beacons": "estimote",
       "cool": "true"
     }
     "identifier": "YOUR_DEVICE_IDENTIFIER",
     "for": "device"
 }
}

Client Errors

Name Description
400_Bad_Request

Incorrect request format
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
404_Not_Found

Attachment with given id does not exist or does not belong to authenticated user

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 404 Not Found
{
  errors: [
    {
      status: 404,
      code: "Not Found",
      message: "Attachment with given id does not exist or does not belong to authenticated user"
    }
  ]
}

Beacon Authentication

Beacon Authentication | 1. Exchange challenges with Beacon

Answers the challenge provided by beacon and provides its own challenge.

post 
https://cloud.estimote.com/v1/beacons/:mac/auth/exchange_challenges

URL Parameter

Field Type Description
mac String

Beacon's MAC address

Request body

Field Type Description
beacon_challenge String

as a hexadecimal string in LSB order

Success 200

Field Type Description
cloud_challenge String

generated challenge as a hexadecimal string in LSB order
beacon_challenge_response String

response to challenge provided by beacon as a hexadecimal string in LSB order

 
HTTP/1.1 200 OK
{
  "cloud_challenge": "abcd123"
  "beacon_challenge_response": "abcd123"
}

500

Name Description
serverError

Error during processing request

Beacon Authentication | 4. Confirm new key.

Sets newly generated key as active one.

post 
https://cloud.estimote.com/v1/beacons/:mac/confirm_new_key

URL Parameter

Field Type Description
mac String

Beacon's MAC address

Success 200

Field Type Description
success String

OK if successfully replaced old key with new one.

404

Name Description
serverError

Beacon not found

500

Name Description
serverError

Error during saving data

Devices

| Delete pending settings

Delete all pending settings for the given devices.

post 
https://cloud.estimote.com/v3/devices/delete_pending_settings

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/devices/delete_pending_settings' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -H "Content-Type: application/json" -d '{"identifiers":["40b53f0f65a40b6f18c91e6f16ff802d","e3a863e1865c"]}'

Success 200

Field Type Description
successes Array

Array of stings containing devices identifiers, which were processed without errors.
errors Array

Array of errors that occurred during this operation.

 
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
    "successes": [
      "40b53f0f65a40b6f18c91e6f16ff802d","e3a863e1865c"
    ],
    "errors": []
  }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a device with the given identifier

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| get Boundaries for 3 zones used in Estimote Monitoring

Fetch Boundaries for 3 zones used in Estimote Moniotring.

get 
https://cloud.estimote.com/v2/devices/:identifier/zones_bounds
curl -X GET 'https://cloud.estimote.com/v2/devices/40b53f0f65a40b6f18c91e6f16ff802d/zones_bounds' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
near Object

Contains boundaries for near zone
  37 Object

Contains pair of boundaries for channel 37
    lower Float

RSSI for lower boundary for Estimote Monitoring
    upper Float

RSSI for lower boundary for Estimote Monitoring
  38 Object

Contains pair of boundaries for channel 38
  39 Object

Contains pair of boundaries for channel 39
medium Object

Contains boundaries for medium zone
far Object

Contains boundaries for far zone

 
HTTP/1.1 200 OK
{
 "near": {
  "37": {
   "lower": -86,
   "upper: -73
  },
  "38": {
   "lower": -86,
   "upper: -73
  },
  "39": {
   "lower": -86,
   "upper: -73
  }
 },
 "medium": {
  "37": {
   "lower": -86,
   "upper: -73
  },
  "38": {
   "lower": -86,
   "upper: -73
  },
  "39": {
   "lower": -86,
   "upper: -73
  }
 },
 "far": {
  "37": {
   "lower": -86,
   "upper: -73
  },
  "38": {
   "lower": -86,
   "upper: -73
  },
  "39": {
   "lower": -86,
   "upper: -73
  }
 }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a device with the given identifier

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| get Boundaries for 3 zones used in Estimote Monitoring

Fetch Boundaries for 3 zones used in Estimote Moniotring.

get 
https://cloud.estimote.com/v3/devices/:identifier/zones_bounds
curl -X GET 'https://cloud.estimote.com/v3/devices/40b53f0f65a40b6f18c91e6f16ff802d/zones_bounds' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
near Object

Contains boundaries for near zone
  37 Object

Contains pair of boundaries for channel 37
    lower Float

RSSI for lower boundary for Estimote Monitoring
    upper Float

RSSI for lower boundary for Estimote Monitoring
  38 Object

Contains pair of boundaries for channel 38
  39 Object

Contains pair of boundaries for channel 39
medium Object

Contains boundaries for medium zone
far Object

Contains boundaries for far zone

 
HTTP/1.1 200 OK

{
  "meta": {},
  "data": {
    "near": {
      "37": {
        "lower": -86,
        "upper: -73
      },
      "38": {
        "lower": -86,
        "upper: -73
      },
      "39": {
        "lower": -86,
        "upper: -73
      }
    },
    "medium": {
      "37": {
        "lower": -86,
         "upper: -73
      },
      "38": {
        "lower": -86,
        "upper: -73
       },
      "39": {
        "lower": -86,
        "upper: -73
      }
    },
    "far": {
      "37": {
        "lower": -86,
        "upper: -73
      },
      "38": {
        "lower": -86,
        "upper: -73
      },
      "39": {
        "lower": -86,
        "upper: -73
      }
    }
  }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a device with the given identifier

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Get device public info

Get public info about a specific device.

get 
https://cloud.estimote.com/v3/devices/:identifier/public

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/YOUR_DEVICE_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
    "identifier": "aaa",
    "color": "white",
    "form_factor": "standard",
    "hardware_type": "beacon"
  }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 

 HTTP/1.1 400 Bad Request
 {
  "errors": [{
    "status": 400,
    "code": "url_param_not_valid",
    "path": "identifier",
    "title": "identifier not valid",
    "message": "\"identifier\" with value \"INVALID_CHARACTERS\" fails to match the required pattern: /^([0-9a-f]{16}){1,2}$/"
  }]
}

| Get devices list

Get the metadata, settings and pending settings for all devices that belong to your account.

get 
https://cloud.estimote.com/v3/devices

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/devices?page=2&device_type=beacon' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/devices?identifiers=aaaaaaaa,bbbbbbbbbb' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Query Parameter

Field Type Description
page optional Integer

From which page data should be returned. Page size = 100.

Default value: 1
identifiers optional String

List of device identifiers to fetch. Identifiers should be separated by comma.
device_type optional String

List of device type which will be returned. Device types can be beacon, mirror or sticker. Default value beacon,mirror,sticker.

 
  HTTP/1.1 200 OK
  {
    "meta": {
      "total_count": 1,
      "page": 1
    },
    "data": [{
      "identifier": "046618f76a44404af14a546e7a37ac3b",
      "shadow": {
        "id": 498,
        "name": "white beacon",
        "tags": [
          "cat"
        ],
        "organization_id": 4036,
        "location": {
          "timezone": "America/Los_Angeles",
          "location_id": 2512,
          "country": "United States",
          "zipcode": null,
          "state": "Alaska",
          "state_code": "AK",
          "city": null,
          "street_name": null,
          "street_number": null,
          "formatted_address": "Devils Desk, Alaska, USA",
          "latitude": 58.4756,
          "longitude": -154.2981
        },
        "indoor_location": {
          "name": "test",
          "identifier": "indoor_test"
        },
        "development_mode": false
      },
      "alerts_configuration": {
        "beacon_stolen_notifications": "off",
        "beacon_fallen_notifications": "off",
        "beacon_battery_notifications": "off",
        "updated_at": "2017-01-30T12:26:10.777Z"
      },
      "alerts": [],
      "hardware_type": "beacon",
      "hardware_revision": "F2.2",
      "hardware_footprint": "165562dd94797b6027cf920b5a1831cbc6a7f25c",
      "color": "white",
      "form_factor": "standard",
      "status_report": {
        "battery_percentage": 95,
        "battery_voltage": 5526,
        "estimated_battery_lifetime": 627,
        "firmware_version": "4.7.0",
        "last_synced": "2017-02-20T12:58:46.375Z",
        "public": false,
        "broken_motion": false,
        "broken_temperature": false,
        "missing_telemetry_data": false
      },
      "settings": {
        "general": {
          "motion_detection_enabled": true,
          "motion_only_enabled": false,
          "dark_to_sleep_enabled": false,
          "dark_to_sleep_threshold": 300,
          "conditional_broadcasting": "off",
          "flip_to_sleep_enabled": false,
          "smart_power_mode_enabled": true,
          "temperature_offset": 0,
          "eddystone_configuration_service_enabled": false,
          "nfc_records": [{
            "data": "com.estimote.apps.main",
            "type": "android_package"
          }],
          "automatic_firmware_update_enabled": false,
          "motion_only_delay": 0,
          "schedule": {
            "enabled": false,
            "start_time": 190,
            "stop_time": 1050
          },
          "wifi": {
            "enabled": true,
            "ssid": "exampleNetwork",
            "password": "aPassThrough"
          },
          "templates": {
            "default_template": "default",
            "lock_template": false
          },
          "estimote_secure_monitoring": {
            "enabled": false,
            "krps": 8,
            "prps": 16,
            "seed": "a7714d65d9f27e1116f3539764146cfc"
          }
        },
        "advertisers": {
          "connectivity": [{
            "index": 1,
            "name": "connectivity",
            "power": -12,
            "interval": 500,
            "shake_to_connect_enabled": false,
            "near_to_connect_enabled": true
          }],
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48025,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "eddystone_eid": [{
            "index": 1,
            "name": "Eddystone EID",
            "enabled": true,
            "interval": 100,
            "power": -30,
            "identity_key": "0123456789abcdef0123456789abcdef",
            "interval_scaler": 10,
            "registered_namespace_id": null,
            "registered_instance_id": null
          }],
          "eddystone_url": [{
            "index": 1,
            "name": "Eddystone URL",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "url": "http://go.esti.be/"
          }],
          "eddystone_telemetry": [{
            "index": 1,
            "name": "Eddystone Telemetry",
            "enabled": false,
            "interval": 950,
            "power": -12
          }],
          "estimote_telemetry": [{
            "index": 1,
            "name": "Estimote Telemetry",
            "enabled": true,
            "interval": 950,
            "power": -12
          }],
          "estimote_location": [{
            "index": 1,
            "name": "Estimote Location",
            "enabled": true,
            "interval": 500,
            "power": 0
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "link_id": null,
            "domain": null,
            "measurement_period": 60
          }],
          "mesh": [{
            "index": 1,
            "name": "Mesh",
            "enabled": true,
            "settings_sync_enabled": false,
            "firmware_sync_enabled": false,
            "interval": 950,
            "settings_version": null,
            "mesh_identifier": 123,
            "mesh_key": "00000000000000000000000000000000",
            "synchronisation_list": [
              "00B0",
              "00B1",
              "00B8",
              "00B9",
              "0100",
              "0200",
              "0300",
              "0101",
              "0201",
              "0301",
              "0102",
              "0202",
              "0302",
              "0103",
              "0203",
              "0303",
              "2001",
              "2002",
              "2003",
              "2004",
              "2006"
            ]
          }]
        },
        "gpio": {
          "config_0": 0,
          "config_1": 0,
          "config_2": 0,
          "config_3": 0,
          "port_data": 0,
          "interrupt_enabled": false,
          "gpio_0_state_led_indicator_enabled": false
        }
      },
      "pending_settings": {
        "advertisers": {
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48024,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "link_id": 52476,
            "domain": "https://www.est1.net/",
            "measurement_period": 60
          }]
        }
      },
      "mesh": {
        "name": null,
        "type": null
      },
      "type": "device"
  }]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 

HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "query_param_not_valid",
      path: "page",
      title: "page not valid",
      message: "\"page\" must be a positive number"
    }
  ]
}

| Get devices to be updated

Fetch identifiers of all devices with pending settings.

get 
https://cloud.estimote.com/v3/devices/pending

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/pending' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
identifiers Array

Array of stings containing devices identifiers.

 
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
    "identifiers": ["40b53f0f65a40b6f18c91e6f16ff802d"]
  }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Get firmware update info

Get info about available firmware update based on devices hardware, current firmware, agent and version

get 
https://cloud.estimote.com/v3/devices/:identifier/firmware_update_info

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/YOUR_DEVICE_IDENTIFIER/firmware_update_info?agent=ios_sdk&version=1.2.0' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/devices/YOUR_DEVICE_IDENTIFIER/firmware_update_info' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Query Parameter

Field Type Description
agent optional String

agent that will be updating the firmware eg. "ios_sdk" or "android_sdk"
version optional String

semver version of agent, if agent is provided, version is required

 
HTTP/1.1 200 OK
{
  "meta": {},
  "data":{
     "hardware": "F1.3d",
     "location": "https://firmware.estimote.com.s3.amazonaws.com/firmware_F1.3d_4.1.0.tar",
     "hash": "bfd43f1a28624295260437a87a947d55e752c5fc",
     "version": "4.1.0",
     "change_log": "the only constant is change",
     "date": "2015-07-07T09:18:19.636Z",
     "softdevice_version": "8.0.0",
     "bootloader_version": "4.0.1",
     "firmware_app_version": "4.1.0"
   }
}
HTTP/1.1 200 OK
{
  "meta": {},
  "data": null
}

Client Errors

Name Description
400_Bad_Request

Invalid query arguments provided
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 401 Unauthorized
{
  errors: [
    {
      status: 401,
      code: "Unauthorized,
      message: "Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps"
    }
  ]
}

| Get latest firmware version for a device.

DEPRECATED

This endpoint is deprecated use now Devices - Get firmware update info

Get latest firmware version for a device, based on its hardware revision, current firmware and Estimote SDK which made the request.

get 
https://cloud.estimote.com/v3/devices/:identifier/newest_firmware

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/f44c4445288c29b8d91de498bcfe2435/newest_firmware' -H "Accept: application/json" -H "User-Agent: EstimoteSDK/4.14.0"
HTTP/1.1 200 OK
   {
     "meta": {},
     "data": {
       "hardware": "I1.2",
       "location": "https://s3.amazonaws.com/firmware.estimote.com/I1.2_v4.12.2-fake_0abd99482f293b15a0562db4e3d4c06e0ed6bb6f.tar",
       "hash": "0abd99482f293b15a0562db4e3d4c06e0ed6bb6f",
       "version": "4.12.2-fake",
       "change_log": "Fake firmware for OTA update testing",
       "date": "2017-04-13T11:12:23.929Z",
       "softdevice_version": "2.0.0",
       "bootloader_version": "4.0.9",
       "firmware_app_version": "4.12.2-fake"
     }
   }

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Get latest hardware revisions and firmware versions.

Get a list of available hardware revisions and their corresponding latest firmware builds. This list can include beta builds.

get 
https://cloud.estimote.com/v3/devices/newest_firmwares

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/newest_firmwares' -H "Accept: application/json"
HTTP/1.1 200 OK
{
  meta: {
  },
  data: {
    "F2.3": "4.9.3",
    "F3.3": "4.11.0",
    "F2.2": "4.9.3",
    "G1.8": "4.9.4",
    "F1.3d": "4.9.3",
    "H1.7": "4.9.4"
  }
}

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Get single device

Get details about a specific device. If user is not the owner of the device or is not authorized, public info will be returned.

get 
https://cloud.estimote.com/v3/devices/:identifier

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/DEVICE_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/devices/DEVICE_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/octet-stream"

Request Headers

Field Type Description
Accept string

Enforce returned data type. For "application/json" Cloud will return a plain text json settings, "application/octet-stream" will return encrypted and compressed json file using device's private key.

Response Headers

Field Type Description
Content-Type string

Content-Type is returned according to sent "Accept" header in appropriate format.
x-deflated boolean

(Only when Content-Type === 'application/octet-stream') Header indicating whether returned binary data has been compressed using deflate algorithm.

Request URL Param

Field Type Description
Device string

identifier

Query Parameter

Field Type Description
embed optional String[]

if provided, will side-load selected fields, allowed: ["attachment"]

Response Parameter

Field Type Description
  color String

device physical color

Allowed values: "blueberry", "mint", "ice", "lemon", "candy", "coconut", "beetroot" 

HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
    "identifier": "YOUR_DEVICE_IDENTIFIER",
    "color": "white",
    "form_factor": "standard",
    "hardware_type": "beacon"
  }
}
  HTTP/1.1 200 OK
  {
    "meta": {
      "total_count": 1,
      "page": 1
    },
    "data": [{
      "identifier": "046618f76a44404af14a546e7a37ac3b",
      "shadow": {
        "id": 498,
        "name": "white beacon",
        "tags": [
          "cat"
        ],
        "organization_id": 4036,
        "location": {
          "timezone": "America/Los_Angeles",
          "location_id": 2512,
          "country": "United States",
          "zipcode": null,
          "state": "Alaska",
          "state_code": "AK",
          "city": null,
          "street_name": null,
          "street_number": null,
          "formatted_address": "Devils Desk, Alaska, USA",
          "latitude": 58.4756,
          "longitude": -154.2981
        },
        "indoor_location": {
          "name": "test",
          "identifier": "indoor_test"
        },
        "development_mode": false
      },
      "alerts_configuration": {
        "beacon_stolen_notifications": "off",
        "beacon_fallen_notifications": "off",
        "beacon_battery_notifications": "off",
        "updated_at": "2017-01-30T12:26:10.777Z"
      },
      "alerts": [],
      "hardware_type": "beacon",
      "hardware_revision": "F2.2",
      "hardware_footprint": "165562dd94797b6027cf920b5a1831cbc6a7f25c",
      "color": "white",
      "form_factor": "standard",
      "status_report": {
        "battery_percentage": 95,
        "battery_voltage": 5526,
        "estimated_battery_lifetime": 627,
        "firmware_version": "4.7.0",
        "last_synced": "2017-02-20T12:58:46.375Z",
        "public": false,
        "broken_motion": false,
        "broken_temperature": false,
        "missing_telemetry_data": false
      },
      "settings": {
        "general": {
          "motion_detection_enabled": true,
          "motion_only_enabled": false,
          "dark_to_sleep_enabled": false,
          "dark_to_sleep_threshold": 300,
          "conditional_broadcasting": "off",
          "flip_to_sleep_enabled": false,
          "smart_power_mode_enabled": true,
          "temperature_offset": 0,
          "eddystone_configuration_service_enabled": false,
          "nfc_records": [{
            "data": "com.estimote.apps.main",
            "type": "android_package"
          }],
          "automatic_firmware_update_enabled": false,
          "motion_only_delay": 0,
          "schedule": {
            "enabled": false,
            "start_time": 190,
            "stop_time": 1050
          },
          "wifi": {
            "enabled": true,
            "ssid": "exampleNetwork",
            "password": "aPassThrough"
          },
          "templates": {
            "default_template": "default",
            "lock_template": false
          },
          "estimote_secure_monitoring": {
            "enabled": false,
            "krps": 8,
            "prps": 16,
            "seed": "a7714d65d9f27e1116f3539764146cfc"
          }
        },
        "advertisers": {
          "connectivity": [{
            "index": 1,
            "name": "connectivity",
            "power": -12,
            "interval": 500,
            "shake_to_connect_enabled": false,
            "near_to_connect_enabled": true
          }],
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48025,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "eddystone_eid": [{
            "index": 1,
            "name": "Eddystone EID",
            "enabled": true,
            "interval": 100,
            "power": -30,
            "identity_key": "0123456789abcdef0123456789abcdef",
            "interval_scaler": 10,
            "registered_namespace_id": null,
            "registered_instance_id": null
          }],
          "eddystone_url": [{
            "index": 1,
            "name": "Eddystone URL",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "url": "http://go.esti.be/"
          }],
          "eddystone_telemetry": [{
            "index": 1,
            "name": "Eddystone Telemetry",
            "enabled": false,
            "interval": 950,
            "power": -12
          }],
          "estimote_telemetry": [{
            "index": 1,
            "name": "Estimote Telemetry",
            "enabled": true,
            "interval": 950,
            "power": -12
          }],
          "estimote_location": [{
            "index": 1,
            "name": "Estimote Location",
            "enabled": true,
            "interval": 500,
            "power": 0
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "link_id": null,
            "domain": null,
            "measurement_period": 60
          }],
          "mesh": [{
            "index": 1,
            "name": "Mesh",
            "enabled": true,
            "settings_sync_enabled": false,
            "firmware_sync_enabled": false,
            "interval": 950,
            "settings_version": null,
            "mesh_identifier": 123,
            "mesh_key": "00000000000000000000000000000000",
            "synchronisation_list": [
              "00B0",
              "00B1",
              "00B8",
              "00B9",
              "0100",
              "0200",
              "0300",
              "0101",
              "0201",
              "0301",
              "0102",
              "0202",
              "0302",
              "0103",
              "0203",
              "0303",
              "2001",
              "2002",
              "2003",
              "2004",
              "2006"
            ]
          }]
        },
        "gpio": {
          "config_0": 0,
          "config_1": 0,
          "config_2": 0,
          "config_3": 0,
          "port_data": 0,
          "interrupt_enabled": false,
          "gpio_0_state_led_indicator_enabled": false
        }
      },
      "pending_settings": {
        "advertisers": {
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48024,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "link_id": 52476,
            "domain": "https://www.est1.net/",
            "measurement_period": 60
          }]
        }
      },
      "mesh": {
        "name": null,
        "type": null
      },
      "type": "device"
  }]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 

HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "query_param_not_valid",
      path: "page",
      title: "page not valid",
      message: ""page" must be a positive number"
    }
  ]
}

| Get the latest device motion state.

Return the latest information about motion status.

get 
https://cloud.estimote.com/v3/devices/:identifier/motion

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/devices/40b53f0f65a40b6f18c91e6f16ff802d/motion' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -H "Content-Type: application/json"

Parameter

Field Type Description
identifier String

Device identifier.

Success 200

Field Type Description
currently_in_motion Boolean

True if device was in motion during last scan.
scanned_at Date

Date of last scan.

 
HTTP/1.1 200 OK
{
  "data": {
    "currently_in_motion": true,
    "scanned_at": "2016-10-17T08:11:37.000"
  }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a device with the given identifier or device doesn't support telemetry

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Post new device settings

Update settings, pending settings, status report and/or shadow information for a device.

post 
https://cloud.estimote.com/v3/devices/:identifier

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/devices/40b334d1d6e81be37d0dd85b9b9f373c' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -d \
'{
  "identifier": "40b334d1d6e81be37d0dd85b9b9f373c",
  "pending_settings": {
    "general": {
     "estimote_secure_monitoring": {
       "enabled": true,
       "krps": 8,
       "prps": 16,
       "seed": "a7714d65d9f27e1116f3539764146cfc"
      }
    },
    "advertisers": {
      "ibeacon": [{
        "index": 1,
        "interval": 1234
      }]
    }
  }
}'

Request Headers

Field Type Description
Accept string

Enforce returned data type. For "application/json" Cloud will return a plain text json settings, "application/octet-stream" will return msgpacked, encrypted and compressed json using device's private key.
Content-Type string

Indicates data format sent by the requestor. "application/json" indicates a well-formed JSON data string, "application/octet-stream" indicates msgpacked, encrypted and compressed json (also with device's private key).
x-deflated boolean

(Only when Content-Type === 'application/octet-stream') Header indicating whether returned binary data has been compressed using deflate algorithm.

Response Headers

Field Type Description
Content-Type string

Content-Type is returned according to sent "Accept" header in appropriate format.
x-deflated boolean

(Only when Content-Type === 'application/octet-stream') Indicates whether returned binary data has been compressed using deflate algorithm.

 
{
    "identifier": "40b334d1d6e81be37d0dd85b9b9f373c",
    "pending_settings": {
        "general": {
            "estimote_secure_monitoring": {
                "enabled": true,
                "krps": 8,
                "prps": 16,
                "seed": "a7714d65d9f27e1116f3539764146cfc"
            }
        },
        "advertisers": {
            "ibeacon": [
                {
                    "index": 1,
                    "interval": 1234
                }
            ]
        }
    }
}

Success 200

Field Type Description
Object Object

containing meta data and encrypted data.

 
  HTTP/1.1 200 OK
  {
    "meta": {
      "total_count": 1,
      "page": 1
    },
    "data": [{
      "identifier": "046618f76a44404af14a546e7a37ac3b",
      "shadow": {
        "id": 498,
        "name": "white beacon",
        "tags": [
          "cat"
        ],
        "organization_id": 4036,
        "location": {
          "timezone": "America/Los_Angeles",
          "location_id": 2512,
          "country": "United States",
          "zipcode": null,
          "state": "Alaska",
          "state_code": "AK",
          "city": null,
          "street_name": null,
          "street_number": null,
          "formatted_address": "Devils Desk, Alaska, USA",
          "latitude": 58.4756,
          "longitude": -154.2981
        },
        "indoor_location": {
          "name": "test",
          "identifier": "indoor_test"
        },
        "development_mode": false
      },
      "alerts_configuration": {
        "beacon_stolen_notifications": "off",
        "beacon_fallen_notifications": "off",
        "beacon_battery_notifications": "off",
        "updated_at": "2017-01-30T12:26:10.777Z"
      },
      "alerts": [],
      "hardware_type": "beacon",
      "hardware_revision": "F2.2",
      "hardware_footprint": "165562dd94797b6027cf920b5a1831cbc6a7f25c",
      "color": "white",
      "form_factor": "standard",
      "status_report": {
        "battery_percentage": 95,
        "battery_voltage": 5526,
        "estimated_battery_lifetime": 627,
        "firmware_version": "4.7.0",
        "last_synced": "2017-02-20T12:58:46.375Z",
        "public": false,
        "broken_motion": false,
        "broken_temperature": false,
        "missing_telemetry_data": false
      },
      "settings": {
        "general": {
          "motion_detection_enabled": true,
          "motion_only_enabled": false,
          "dark_to_sleep_enabled": false,
          "dark_to_sleep_threshold": 300,
          "conditional_broadcasting": "off",
          "flip_to_sleep_enabled": false,
          "smart_power_mode_enabled": true,
          "temperature_offset": 0,
          "eddystone_configuration_service_enabled": false,
          "nfc_records": [{
            "data": "com.estimote.apps.main",
            "type": "android_package"
          }],
          "automatic_firmware_update_enabled": false,
          "motion_only_delay": 0,
          "schedule": {
            "enabled": false,
            "start_time": 190,
            "stop_time": 1050
          },
          "wifi": {
            "enabled": true,
            "ssid": "exampleNetwork",
            "password": "aPassThrough"
          },
          "templates": {
            "default_template": "default",
            "lock_template": false
          },
          "estimote_secure_monitoring": {
            "enabled": false,
            "krps": 8,
            "prps": 16,
            "seed": "a7714d65d9f27e1116f3539764146cfc"
          }
        },
        "advertisers": {
          "connectivity": [{
            "index": 1,
            "name": "connectivity",
            "power": -12,
            "interval": 500,
            "shake_to_connect_enabled": false,
            "near_to_connect_enabled": true
          }],
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48025,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "eddystone_eid": [{
            "index": 1,
            "name": "Eddystone EID",
            "enabled": true,
            "interval": 100,
            "power": -30,
            "identity_key": "0123456789abcdef0123456789abcdef",
            "interval_scaler": 10,
            "registered_namespace_id": null,
            "registered_instance_id": null
          }],
          "eddystone_url": [{
            "index": 1,
            "name": "Eddystone URL",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "url": "http://go.esti.be/"
          }],
          "eddystone_telemetry": [{
            "index": 1,
            "name": "Eddystone Telemetry",
            "enabled": false,
            "interval": 950,
            "power": -12
          }],
          "estimote_telemetry": [{
            "index": 1,
            "name": "Estimote Telemetry",
            "enabled": true,
            "interval": 950,
            "power": -12
          }],
          "estimote_location": [{
            "index": 1,
            "name": "Estimote Location",
            "enabled": true,
            "interval": 500,
            "power": 0
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "link_id": null,
            "domain": null,
            "measurement_period": 60
          }],
          "mesh": [{
            "index": 1,
            "name": "Mesh",
            "enabled": true,
            "settings_sync_enabled": false,
            "firmware_sync_enabled": false,
            "interval": 950,
            "settings_version": null,
            "mesh_identifier": 123,
            "mesh_key": "00000000000000000000000000000000",
            "synchronisation_list": [
              "00B0",
              "00B1",
              "00B8",
              "00B9",
              "0100",
              "0200",
              "0300",
              "0101",
              "0201",
              "0301",
              "0102",
              "0202",
              "0302",
              "0103",
              "0203",
              "0303",
              "2001",
              "2002",
              "2003",
              "2004",
              "2006"
            ]
          }]
        },
        "gpio": {
          "config_0": 0,
          "config_1": 0,
          "config_2": 0,
          "config_3": 0,
          "port_data": 0,
          "interrupt_enabled": false,
          "gpio_0_state_led_indicator_enabled": false
        }
      },
      "pending_settings": {
        "advertisers": {
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48024,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "link_id": 52476,
            "domain": "https://www.est1.net/",
            "measurement_period": 60
          }]
        }
      },
      "mesh": {
        "name": null,
        "type": null
      },
      "type": "device"
  }]
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

| Update multiple devices

Update multiple devices' metadata and settings. The settings should follow the same JSON format as returned by the /v2/devices endpoint, so please use it as your reference. The endpoint accepts an array of beacons, so the "identifier" key is required. Changes to the settings of the physical beacon need to be made in the 'pending_settings' key to be later synchronized by an Estimote SDK-equipped app. Please note different beacons have different capabilities (e.g. multipacket, light sensor, etc) so not all properties apply to all beacons.

NB: Examples below contain line breaks for readability purposes, please remove them before use.

post 
https://cloud.estimote.com/v3/devices/bulk

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/devices/bulk' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -H "Content-Type: application/json" -d
'[{
     "identifier": "40b53f0f65a40b6f18c91e6f16ff802d",
     "shadow": {
       "location": {
         "latitude": 40.7383056,
         "longitude": -73.991184
       }
     }
   }, {
     "identifier": "e3a863e1865c",
     "shadow": {
       "location": {
         "latitude": 40.7383056,
         "longitude": -73.991184
       }
     }
}]'
curl -X POST 'https://cloud.estimote.com/v3/devices/bulk' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -H "Content-Type: application/json" -d
'[{
     "identifier": "40b53f0f65a40b6f18c91e6f16ff802d",
     "pending_settings": {
       "advertisers": {
         "ibeacon": [{
           "index": 1,
           "uuid": "B36C37A3-875F-4E56-9905-1F8BDC815E03",
           "power": -4,
           "interval": 500,
           "non_strict_mode_enabled": true
         }]
       }
     }
  }, {
     "identifier": "e3a863e1865c",
     "pending_settings": {
       "advertisers": {
         "ibeacon": [{
           "index": 1,
           "uuid": "B36C37A3-875F-4E56-9905-1F8BDC815E03",
           "power": -4,
           "interval": 500,
           "non_strict_mode_enabled": true
         }]
       }
     }
}]'
curl -X POST 'https://cloud.estimote.com/v3/devices/bulk' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -H "Content-Type: application/json" -d
'[{
     "identifier": "40b53f0f65a40b6f18c91e6f16ff802d",
     "pending_settings": {
       "advertisers": {
         "eddystone_uid": [{
           "index": 1,
           "enabled": false
         }]
       }
     }
   }, {
     "identifier": "e3a863e1865c",
     "pending_settings": {
       "advertisers": {
         "eddystone_uid": [{
           "index": 1,
           "enabled": false
         }]
       }
     }
}]'
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
    "successes":["40b53f0f65a40b6f18c91e6f16ff802d","e3a863e1865c"],
    "errors":[]
    }
}

Firmware

Firmware | Get the newest firmware available via OTA for given device

get 
https://cloud.estimote.com/v1/devices/:identifier/newest_firmware

URL Parameter

Field Type Description
identifier String

Identifier of the device

 
HTTP/1.1 200 OK
{
  "hardware": "F1.3d",
  "location": "https://firmware.estimote.com.s3.amazonaws.com/firmware_F1.3d_4.1.0.tar",
  "hash": "bfd43f1a28624295260437a87a947d55e752c5fc",
  "version": "4.1.0",
  "change_log": "the only constant is change",
  "date": "2015-07-07T09:18:19.636Z",
  "softdevice_version": "8.0.0",
  "bootloader_version": "4.0.1",
  "firmware_app_version": "4.1.0"
}

401 Unauthorized

Name Description
notAuthorizedError

Not authorized

404 Not found

Name Description
notFound

Device not found or no firmware available.

500 Internal Server Error

Name Description
internalServerError

Unable to handle the request due to an exception

FirmwareReports

FirmwareReports | Store batch of firmware error reports

Stores the batch of error reports read from the device.

post 
https://cloud.estimote.com/v1/devices/:identifier/reports

URL parameter

Field Type Description
identifier String

Device identifier

Request body

Field Type Description
report Array

Each hash in the Array contains one report
  content String

Content of the error report.
  app_commit_hash String

Hash of the commit from which the current device application has been built
  boot_commit_hash String

Hash of the commit from which the current device bootloader has been built

 
HTTP/1.1 200 OK
{
  "success": true
}

Giveaway Codes

Giveaway Codes | Assign devices from given code

Assign devices from given code

post 
https://cloud.estimote.com/giveaway_codes

Request body

Field Type Description
code String

Giveaway Code.

Success 200

Field Type Description
success Object

Contain identifiers of assigned devices
  macs Array

Macs of assigned beacons
  identifiers Array

Identifiers of assigned stickers

Client Errors

Name Description
401

Unauthorized
404

Code not found
412

Missing params code

Server Errors

Name Description
500

Unknown error

Indoor

Indoor | Add pin to specific location

Add pin to specific location

post 
https://cloud.estimote.com/v1/indoor/locations/:identifier/pins
curl -X POST 'https://cloud.estimote.com/v1/indoor/locations/PASTE_HERE_YOUR_IDENTIFIER/pins' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json"
{
    "x": 1,
    "y": 0,
    "orientation": 0,
    "name": "Downhill bike",
    "type": "bike"
}

HTTP/1.1 200 OK
{
  "id": 1012,
  "x": 1,
  "y": 0,
  "orientation": 0,
  "name": "Downhill bike",
  "type": "bike"
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor | Change Visibility of Location

Changes location visibility between public and private

post 
https://cloud.estimote.com/indoor/locations/:identifier/public

URL Parameter

Field Type Description
identifier String

Location identifier

Request body

Field Type Description
public Boolean

Should the location be public

Success 200

Field Type Description
locations IndoorLocation

Single location.
  name String

Human readable name of the location
  identifier String

Unique identifier of the location
  public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
  owner String

Owner of the location
  orientation Number

Orientation of the location with regard to the North
  walls Array

Boundary segments of the location's perimeter
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
  beacons Array

Beacons inside the location
    beacon Object

Beacon specific informations
      mac String

Identifier of the beacon
      color String

Color of the beacon
      uuid String

iBeacons UUID broadcasted by the beacon
      major Number

iBeacons Major broadcasted by the beacon
      minor Number

iBeacons Minor broadcasted by the beacon
    position Object

Position of the beacon
      x Number

Beacon X coordinate
      y Number

Beacon Y coordinate
      orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
  linear_objects Array

Linear objects inside the location
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
    type Number

Type of the linear object (0 - door, 1 - window).
  pins Array

Pins assigned to the location
    id Number

Unique identifier of pin
    x Number

Pin X coordinate
    y Number

Pin Y coordinate
    orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
    name String

Pin name
    type String

Pin type
  location_id Number
  latitude Number

Latitude of IndoorLocation
  longitude Number

Longitude of IndoorLocation
  location Object

Address of IndoorLocation
    country String

Country
    state String

State
    state_code String

State Code
    city String

City
    street_name String

Street Name
    street_number String

Street Number
    formatted_address String

Formatted Address
  meta Object

Meta data of the location
    configured_beacons Array

Beacons configured for the location during wizard
  draft Boolean

Definies wheter location is a draft
  accepted Boolean

Definies wheter location draft was accepted by user
  created_at String
  updated_at String

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Delete location

Deletes user's location registered to account with Indoor iOS app

delete 
https://cloud.estimote.com/indoor/locations/:identifier

Success 200

Field Type Description
location IndoorLocation

Single location that was removed.
name String

Human readable name of the location
identifier String

Unique identifier of the location
public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
owner String

Owner of the location
orientation Number

Orientation of the location with regard to the North
walls Array

Boundary segments of the location's perimeter
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
beacons Array

Beacons inside the location
  beacon Object

Beacon specific informations
    mac String

Identifier of the beacon
    color String

Color of the beacon
  position Object

Position of the beacon
    x Number

Beacon X coordinate
    y Number

Beacon Y coordinate
    orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
linear_objects Array

Linear objects inside the location
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
  type Number

Type of the linear object (0 - door, 1 - window).
pins Array

Pins assigned to the location
  id Number

Unique identifier of pin
  x Number

Pin X coordinate
  y Number

Pin Y coordinate
  orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
  name String

Pin name
  type String

Pin type

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Delete specific pin.

Delete specific pin

delete 
https://cloud.estimote.com/v1/indoor/locations/pins/:id
curl -X DELETE 'https://cloud.estimote.com/v1/indoor/locations/pins/PASTE_HERE_YOUR_PIN_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json"
HTTP/1.1 200 OK

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Specific pin doesn't exist
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor | Get all Indoor locations in given Geographical Location

Lists all location registered to account with Indoor iOS app, withing vien Geographical Location

get 
https://cloud.estimote.com/v1/locations/:location_id/indoor_locations

Success 200

Field Type Description
locations Array[IndoorLocation]

Array of locations
  name String

Human readable name of the location
  identifier String

Unique identifier of the location
  public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
  owner String

Owner of the location
  orientation Number

Orientation of the location with regard to the North
  walls Array

Boundary segments of the location's perimeter
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
  beacons Array

Beacons inside the location
    beacon Object

Beacon specific informations
      mac String

Identifier of the beacon
      color String

Color of the beacon
      uuid String

iBeacons UUID broadcasted by the beacon
      major Number

iBeacons Major broadcasted by the beacon
      minor Number

iBeacons Minor broadcasted by the beacon
    position Object

Position of the beacon
      x Number

Beacon X coordinate
      y Number

Beacon Y coordinate
      orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
  linear_objects Array

Linear objects inside the location
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
    type Number

Type of the linear object (0 - door, 1 - window).
  pins Array

Pins assigned to the location
    id Number

Unique identifier of pin
    x Number

Pin X coordinate
    y Number

Pin Y coordinate
    orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
    name String

Pin name
    type String

Pin type
  location_id Number
  latitude Number

Latitude of IndoorLocation
  longitude Number

Longitude of IndoorLocation
  location Object

Address of IndoorLocation
    country String

Country
    state String

State
    state_code String

State Code
    city String

City
    street_name String

Street Name
    street_number String

Street Number
    formatted_address String

Formatted Address
  meta Object

Meta data of the location
    configured_beacons Array

Beacons configured for the location during wizard
  draft Boolean

Definies wheter location is a draft
  accepted Boolean

Definies wheter location draft was accepted by user
  created_at String
  updated_at String

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Get list of all own drafts of locations

Lists all drafts locations registered to account with Indoor iOS app

get 
https://cloud.estimote.com/v1/indoor/locations/drafts

Success 200

Field Type Description
locations Array[IndoorLocation]

Array of locations
  name String

Human readable name of the location
  identifier String

Unique identifier of the location
  public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
  owner String

Owner of the location
  orientation Number

Orientation of the location with regard to the North
  walls Array

Boundary segments of the location's perimeter
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
  beacons Array

Beacons inside the location
    beacon Object

Beacon specific informations
      mac String

Identifier of the beacon
      color String

Color of the beacon
      uuid String

iBeacons UUID broadcasted by the beacon
      major Number

iBeacons Major broadcasted by the beacon
      minor Number

iBeacons Minor broadcasted by the beacon
    position Object

Position of the beacon
      x Number

Beacon X coordinate
      y Number

Beacon Y coordinate
      orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
  linear_objects Array

Linear objects inside the location
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
    type Number

Type of the linear object (0 - door, 1 - window).
  pins Array

Pins assigned to the location
    id Number

Unique identifier of pin
    x Number

Pin X coordinate
    y Number

Pin Y coordinate
    orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
    name String

Pin name
    type String

Pin type
  location_id Number
  latitude Number

Latitude of IndoorLocation
  longitude Number

Longitude of IndoorLocation
  location Object

Address of IndoorLocation
    country String

Country
    state String

State
    state_code String

State Code
    city String

City
    street_name String

Street Name
    street_number String

Street Number
    formatted_address String

Formatted Address
  meta Object

Meta data of the location
    configured_beacons Array

Beacons configured for the location during wizard
  draft Boolean

Definies wheter location is a draft
  accepted Boolean

Definies wheter location draft was accepted by user
  created_at String
  updated_at String

Client Errors

Name Description
401

Unauthorized

Server Errors

Name Description
500

Unknown error

Indoor | Get pins for location.

Get pins for location

get 
https://cloud.estimote.com/v1/indoor/locations/:identifier/pins
curl -X GET 'https://cloud.estimote.com/v1/indoor/locations/PASTE_HERE_YOUR_IDENTIFIER/pins' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN
HTTP/1.1 200 OK
[
  {
    "x": 1,
    "y": 0,
    "orientation": 0,
    "id": 8,
    "name": "Downhill bike",
    "type": "bike"
  }
]

Client Errors

Name Description
400

Bad_Request Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401

Unauthorized Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404

Not_Found Specific pin doesn't exist
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500

Internal_Server_Error Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor | Get stickers sightings for location

Get all sticker sightings for given location

get 
https://cloud.estimote.com/v1/indoor/locations/:identifier/sticker_sightings

url

Field Type Description
identifier String

Location's unique identifier

Success 200

Field Type Description
identifier String

Location's unique identifier
name String

Human readable location name
nearables Object[]

List of nearables seen in the location
  position Object

Estimated position of a device within a location
    x Number

X coordinate
    y Number

Y coordinate
  rssi Number

Signal strength
  last_seen_at Number

Date when device was seen at
  sticker Object

Seen sticker properties
    identifier String

Sticker unique ID
    name String

Name (only if user is owner or sticker is public)
    type String

Type
    color String

Color
    public Boolean

True if sticker is public
    authorized Boolean

True if current user is an owner of the sticker

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Get users beacon sightings

Get users beacon sightings for all locations

get 
https://cloud.estimote.com/v1/indoor/beacon_sightings

Success 200

Field Type Description
sightings Object[]
  location Object

Indoor location
    identifier String

Location's unique identifier
    name String

Human readable name
    owner String

Owner (obfuscated if user's not an owner of this location)
  position Object

Estimated position of a device within a location
    x Number

X coordinate
    y Number

Y coordinate
  rssi Number

Signal strength
  last_seen_at Number

Date when device was seen at
  beacon Object

Seen beacon properties
    mac String

MAC address
    name String

Name
    color String

Color
    uuid String

Proximity UUID
    major String

Major
    minor String

Minor

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Get users sticker sightings

Get users sticker sightings for all locations

get 
https://cloud.estimote.com/v1/indoor/sticker_sightings

Success 200

Field Type Description
sightings Object[]
  location Object

Indoor location
    identifier String

Location's unique identifier
    name String

Human readable name
    owner String

Owner (obfuscated if user's not an owner of this location)
  position Object

Estimated position of a device within a location
    x Number

X coordinate
    y Number

Y coordinate
  rssi Number

Signal strength
  last_seen_at Number

Date when device was seen at
  sticker Object

Seen sticker properties
    identifier String

Sticker unique ID
    name String

Name
    type String

Type
    color String

Color

Client Errors

Name Description
401

Unauthorized
404

Not Found

Server Errors

Name Description
500

Unknown error

Indoor | Mark location as accepted

Set accepted field as true

post 
https://cloud.estimote.com/v1/indoor/locations/:identifier/accept

URL Parameter

Field Type Description
identifier String

Location identifier

Client Errors

Name Description
404

Location not found

Server Errors

Name Description
500

Unknown error

Indoor | Post usage statistics and get positioning algorithm parameters

Post Indoor Location SDK usage statistics and get positioning algorithm parameters.

post 
https://cloud.estimote.com/v1/indoor/positioning_parameters

Permission: internal 

curl -X POST 'https://cloud.estimote.com/v1/indoor/positioning_parameters' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json" -d '{"device_model": "DEVICE_MODEL", "sdk_version": "SDK_VERSION", "platform": "PLATFORM", "events":[{"app_name": "APP_NAME", "device_id": "DEVICE_IDENTIFIER", "date": "DATE_WITH_ZONE", "event": "EVENT_NAME", "sdk_version": "SDK_VERSION", "platform": "PLATFORM", "location_identifier": "LOCATION_IDENTIFIER"}]}'

body

Field Type Description
device_model String

Model of the device using the Indoor Location SDK
sdk_version String

Version of the Indoor Location SDK
platform String

Platform system running on the device
events Object[]

List of Indoor Location SDK events
  app_name String

Name of the application
  device_id String

Unique identifier of a device (usually generated by a mobile app)
  device_model String

Model of the device that generated the event
  date Date

Date when event happened
  event String

Name of the event that happened
  sdk_version String

Version of the Indoor Location SDK
  platform String

Platform system running on the device that generated the event
  location_identifier String

Indoor location identifier

 

HTTP/1.1 200 OK
{
  "beacon_parameters": {
    "F1.1": {
      "measured_power": -52.5
    },
    "FG.12": {
      "measured_power": -54.3
    },
  }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor | Reject location

Reject location

post 
https://cloud.estimote.com/v1/indoor/locations/:identifier/reject

URL Parameter

Field Type Description
identifier String

Location identifier

Request body

Field Type Description
text String

Reason of rejection

Client Errors

Name Description
400

Missing text field
401

Unauthorized
404

Location not found

Server Errors

Name Description
500

Unknown error

Indoor | Save sightings

Saves sightings for a given indoor location (any device)

post 
https://cloud.estimote.com/v1/indoor/locations/:identifier/sightings

url

Field Type Description
identifier String

Location identifier

body

Field Type Description
device_id String

Unique identifier of a device (usually generated by a mobile app)
sightings Object[]

List of sightings
  device_identifier String

Sticker ID or Beacon MAC
  device_type String

Type of a seen device

Default value: sticker

Allowed values: "sticker", "beacon"

  seen_at Date

Date when sticker was seen at
  rssi Number

Signal strength
  position Object

Estimated position of a device within a given location
    x Number

X coordinate
    y Number

Y coordinate

Client Errors

Name Description
400

Bad request

Server Errors

Name Description
500

Unknown error

Indoor | Save sticker sightings

Saves sightings for a given indoor location

post 
https://cloud.estimote.com/v1/indoor/locations/:identifier/sticker_sightings

URL Parameter

Field Type Description
identifier String

Location identifier

Request body

Field Type Description
device_id String

Unique identifier of a device (usually generated by a mobile app)
sightings Object[]

List of sightings
  sticker_identifier String

Sticker ID
  seen_at Date

Date when sticker was seen at
  rssi Number

Signal strength
  position Object

Estimated position of a sticker within a location
    x Number

X coordinate
    y Number

Y coordinate

Client Errors

Name Description
400

Bad request

Server Errors

Name Description
500

Unknown error

Indoor | Update specific pin.

Update specific pin

put 
https://cloud.estimote.com/v1/indoor/locations/pins/:id
curl -X PUT 'https://cloud.estimote.com/v1/indoor/locations/pins/PASTE_HERE_YOUR_PIN_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json"
{
    "x": 1,
    "y": 0,
    "orientation": 0,
    "name": "Downhill bike",
    "type": "bike"
}

HTTP/1.1 200 OK
{
  "id": 1012,
  "x": 1,
  "y": 0,
  "orientation": 0,
  "name": "Downhill bike",
  "type": "bike"
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Specific pin doesn't exist
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location

Indoor Location | Delete location

Delete user's location

delete 
https://cloud.estimote.com/indoor/locations/:identifier

Permission: public 

curl -X DELETE 'https://cloud.estimote.com/v1/indoor/locations/LOCATION_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
name String

Human readable name of the location
identifier String

Unique identifier of the location
public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
owner String

Owner of the location
orientation Number

Orientation of the location with regard to the North
walls Array

Boundary segments of the location's perimeter
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
beacons Array

Beacons inside the location
  beacon Object

Beacon specific informations
    mac String

Identifier of the beacon
    color String

Color of the beacon
  position Object

Position of the beacon
    x Number

Beacon X coordinate
    y Number

Beacon Y coordinate
    orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
linear_objects Array

Linear objects inside the location
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
  type Number

Type of the linear object (0 - door, 1 - window).
pins Array

Pins assigned to the location
  id Number

Unique identifier of pin
  x Number

Pin X coordinate
  y Number

Pin Y coordinate
  orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
  name String

Pin name
  type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a location with specified identifier

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location | Get a single location

Gets a single location which is either public or belongs to authorized user

get 
https://cloud.estimote.com/indoor/locations/:identifier

Permission: public 

curl -X GET 'https://cloud.estimote.com/v1/indoor/locations/LOCATION_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
name String

Human readable name of the location
identifier String

Unique identifier of the location
public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
owner String

Owner of the location
orientation Number

Orientation of the location with regard to the North
walls Array

Boundary segments of the location's perimeter
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
beacons Array

Beacons inside the location
  beacon Object

Beacon specific informations
    mac String

Identifier of the beacon
    color String

Color of the beacon
  position Object

Position of the beacon
    x Number

Beacon X coordinate
    y Number

Beacon Y coordinate
    orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
linear_objects Array

Linear objects inside the location
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
  type Number

Type of the linear object (0 - door, 1 - window).
pins Array

Pins assigned to the location
  id Number

Unique identifier of pin
  x Number

Pin X coordinate
  y Number

Pin Y coordinate
  orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
  name String

Pin name
  type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_Not_Found

Could not find a location with specified identifier

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location | Get all locations

Gets all locations belonging to the user

get 
https://cloud.estimote.com/indoor/locations

Permission: public 

curl -X GET 'https://cloud.estimote.com/v1/indoor/locations' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Success 200

Field Type Description
locations Array

An array of locations
  name String

Human readable name of the location
  identifier String

Unique identifier of the location
  public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
  owner String

Owner of the location
  orientation Number

Orientation of the location with regard to the North
  walls Array

Boundary segments of the location's perimeter
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
  beacons Array

Beacons inside the location
    beacon Object

Beacon specific informations
      mac String

Identifier of the beacon
      color String

Color of the beacon
    position Object

Position of the beacon
      x Number

Beacon X coordinate
      y Number

Beacon Y coordinate
      orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
  linear_objects Array

Linear objects inside the location
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
    type Number

Type of the linear object (0 - door, 1 - window).
  pins Array

Pins assigned to the location
    id Number

Unique identifier of pin
    x Number

Pin X coordinate
    y Number

Pin Y coordinate
    orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
    name String

Pin name
    type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location | Get nearby public locations

Gets nearby public locations based on provided list of nearby beacons

post 
https://cloud.estimote.com/indoor/locations/public

Permission: public 

curl -X POST 'https://cloud.estimote.com/v1/indoor/locations/public' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json" -d '{"macs":["BEACON_IDENTIFIER_1","BEACON_IDENTIFIER_2"]}'

Request body

Field Type Description
macs String[]

Identifiers of the nearby beacons

Success 200

Field Type Description
locations Array

An array of locations
  name String

Human readable name of the location
  identifier String

Unique identifier of the location
  public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
  owner String

Owner of the location
  orientation Number

Orientation of the location with regard to the North
  walls Array

Boundary segments of the location's perimeter
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
  beacons Array

Beacons inside the location
    beacon Object

Beacon specific informations
      mac String

Identifier of the beacon
      color String

Color of the beacon
    position Object

Position of the beacon
      x Number

Beacon X coordinate
      y Number

Beacon Y coordinate
      orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
  linear_objects Array

Linear objects inside the location
    x1 Number

1st end point X coordinate
    y1 Number

1st end point Y coordinate
    x2 Number

2nd end point X coordinate
    y2 Number

2nd end point Y coordinate
    orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
    type Number

Type of the linear object (0 - door, 1 - window).
  pins Array

Pins assigned to the location
    id Number

Unique identifier of pin
    x Number

Pin X coordinate
    y Number

Pin Y coordinate
    orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
    name String

Pin name
    type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location | Replace existing location

Replace existing location with a new location

put 
https://cloud.estimote.com/indoor/locations

Permission: public 

curl -X PUT 'https://cloud.estimote.com/v1/indoor/locations' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json"
{
    "name": "Example location",
    "public": false,
    "orientation": 23.5,
    "walls": [
        {
            "x1": 0,
            "y1": 0,
            "x2": 0,
            "y2": 5,
            "orientation": 90
        },
        {
            "x1": 0,
            "y1": 5,
            "x2": 7,
            "y2": 5,
            "orientation": 180
        },
        {
            "x1": 7,
            "y1": 5,
            "x2": 9,
            "y2": -2,
            "orientation": 254.054604099077
        },
        {
            "x1": 9,
            "y1": -2,
            "x2": 4,
            "y2": 0,
            "orientation": 21.8014094863518
        },
        {
            "x1": 4,
            "y1": 0,
            "x2": 0,
            "y2": 0,
            "orientation": 0
        }
    ],
    "beacons": [
        {
            "beacon": {
                "mac": "c32e9dab6b87"
            },
            "position": {
                "x": 5,
                "y": 2,
                "orientation": 0
            }
        },
        {
            "beacon": {
                "mac": "ce0a257b725f"
            },
            "position": {
                "x": 7.54944225579476,
                "y": 3.07695210471835,
                "orientation": 254.054604099077
            }
        },
        {
            "beacon": {
                "mac": "7c72a730bc03ef3b8be89d4f9f8d7d23"
            },
            "position": {
                "x": 3,
                "y": 5,
                "orientation": 180
            }
        },
        {
            "beacon": {
                "mac": "5cc24a9872002ee567b4156a7c57b005"
            },
            "position": {
                "x": 0,
                "y": 2.5,
                "orientation": 90
            }
        }
    ],
    "linear_objects": [
        {
            "x1": 1,
            "y1": 0,
            "x2": 3,
            "y2": 0,
            "orientation": 0,
            "type": 1
        },
        {
            "x1": 0,
            "y1": 1,
            "x2": 0,
            "y2": 2,
            "orientation": 90,
            "type": 0
        }
    ],
    "pins": [
        {
            "x": 1,
            "y": 0,
            "orientation": 0,
            "name": "Downhill bike",
            "type": "bike"
        },
        {
            "x": 1,
            "y": -1,
            "orientation": 100,
            "name": "My chair",
            "type": "furniture"
        }
    ]
}

Success 200

Field Type Description
name String

Human readable name of the location
identifier String

Unique identifier of the location
public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
owner String

Owner of the location
orientation Number

Orientation of the location with regard to the North
walls Array

Boundary segments of the location's perimeter
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
beacons Array

Beacons inside the location
  beacon Object

Beacon specific informations
    mac String

Identifier of the beacon
    color String

Color of the beacon
  position Object

Position of the beacon
    x Number

Beacon X coordinate
    y Number

Beacon Y coordinate
    orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
linear_objects Array

Linear objects inside the location
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
  type Number

Type of the linear object (0 - door, 1 - window).
pins Array

Pins assigned to the location
  id Number

Unique identifier of pin
  x Number

Pin X coordinate
  y Number

Pin Y coordinate
  orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
  name String

Pin name
  type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Indoor Location | Store new location

Store new location

post 
https://cloud.estimote.com/indoor/locations

Permission: public 

curl -X POST 'https://cloud.estimote.com/v1/indoor/locations' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json"
{
    "name": "Example location",
    "public": false,
    "orientation": 23.5,
    "walls": [
        {
            "x1": 0,
            "y1": 0,
            "x2": 0,
            "y2": 5,
            "orientation": 90
        },
        {
            "x1": 0,
            "y1": 5,
            "x2": 7,
            "y2": 5,
            "orientation": 180
        },
        {
            "x1": 7,
            "y1": 5,
            "x2": 9,
            "y2": -2,
            "orientation": 254.054604099077
        },
        {
            "x1": 9,
            "y1": -2,
            "x2": 4,
            "y2": 0,
            "orientation": 21.8014094863518
        },
        {
            "x1": 4,
            "y1": 0,
            "x2": 0,
            "y2": 0,
            "orientation": 0
        }
    ],
    "beacons": [
        {
            "beacon": {
                "mac": "c32e9dab6b87"
            },
            "position": {
                "x": 5,
                "y": 2,
                "orientation": 0
            }
        },
        {
            "beacon": {
                "mac": "ce0a257b725f"
            },
            "position": {
                "x": 7.54944225579476,
                "y": 3.07695210471835,
                "orientation": 254.054604099077
            }
        },
        {
            "beacon": {
                "mac": "7c72a730bc03ef3b8be89d4f9f8d7d23"
            },
            "position": {
                "x": 3,
                "y": 5,
                "orientation": 180
            }
        },
        {
            "beacon": {
                "mac": "5cc24a9872002ee567b4156a7c57b005"
            },
            "position": {
                "x": 0,
                "y": 2.5,
                "orientation": 90
            }
        }
    ],
    "linear_objects": [
        {
            "x1": 1,
            "y1": 0,
            "x2": 3,
            "y2": 0,
            "orientation": 0,
            "type": 1
        },
        {
            "x1": 0,
            "y1": 1,
            "x2": 0,
            "y2": 2,
            "orientation": 90,
            "type": 0
        }
    ],
    "pins": [
        {
            "x": 1,
            "y": 0,
            "orientation": 0,
            "name": "Downhill bike",
            "type": "bike"
        },
        {
            "x": 1,
            "y": -1,
            "orientation": 100,
            "name": "My chair",
            "type": "furniture"
        }
    ]
}

Success 200

Field Type Description
name String

Human readable name of the location
identifier String

Unique identifier of the location
public Boolean

If true, everyone can find and fetch this location. If false only owner of the location.
owner String

Owner of the location
orientation Number

Orientation of the location with regard to the North
walls Array

Boundary segments of the location's perimeter
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the boundary segment - orientation of the vector perpendicular to the segment and pointing toward center of location
beacons Array

Beacons inside the location
  beacon Object

Beacon specific informations
    mac String

Identifier of the beacon
    color String

Color of the beacon
  position Object

Position of the beacon
    x Number

Beacon X coordinate
    y Number

Beacon Y coordinate
    orientation Number

Orientation of the beacon defined as a direction from back of the beacon toward the front
linear_objects Array

Linear objects inside the location
  x1 Number

1st end point X coordinate
  y1 Number

1st end point Y coordinate
  x2 Number

2nd end point X coordinate
  y2 Number

2nd end point Y coordinate
  orientation Number

Orientation of the linear object - orientation of the vector perpendicular to the object and pointing toward front of the object
  type Number

Type of the linear object (0 - door, 1 - window).
pins Array

Pins assigned to the location
  id Number

Unique identifier of pin
  x Number

Pin X coordinate
  y Number

Pin Y coordinate
  orientation Number

Orientation of the pin defined as a direction from back of the pin toward the front
  name String

Pin name
  type String

Pin type

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
402_Payment_Required

Access to this endpoint requires enabling the Indoor Location feature. You can check our plans https://estimote.com/#saas.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

LTE

LTE | Create new user message

Create new user message

post 
https://cloud.estimote.com/v3/lte/user_messages

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/lte/user_messages' \
-u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN \
-H "Content-Type: application/json" \
-d '
{
  "device_identifier": "YOUR_DEVICE_IDENTIFIER",
  "type": "MY_TYPE",
  "payload": {
     "message": 1
  }
}'

Body

Field Type Description
body Object
  device_identifier String
  type String

category of user message
  payload Object
  ttl optional Number

ttl in seconds, if ttl is specified message will be sent only within specified ttl otherwise it will be discarded
  volatile optional Boolean

if true is passed message will not require confirmation from LTE Beacon use if for messages with lower business value

 
HTTP/1.1 201 OK
{
  "data": {
    "uuid": "1c698cae-e215-4dec-90d1-7649ec2ebf62",
    "device_identifier": "YOUR_DEVICE_IDENTIFIER",
    "type": "MY_TYPE",
    "payload": {
      "message": 1
    },
    "delivered": false,
    "delivered_at": null,
    "valid_until": null,
    "created_at": "2019-04-05T08:26:58.765Z",
    "volatile": false
  },
  "meta": {}
}

Client Errors

Name Description
400_Bad_Request
401_Unauthorized
403_Forbidden

device does not belong to authenticated organization
404_Not_Found

device does not exist

LTE | Delete user message

Delete user message

delete 
https://cloud.estimote.com/v3/lte/user_messages

Permission: public 

curl -X DELETE 'https://cloud.estimote.com/v3/lte/user_messages/YOUR_USER_MESSAGE_UUID' \
-u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Url

Field Type Description
uuid String

v4 of user message

 
HTTP/1.1 200 OK
{
  "data": {
    "uuid": "YOUR_USER_MESSAGE_UUID",
    "device_identifier": "e073ba800c471b622870fa87199ab52b",
    "type": "MY_TYPE",
    "payload": {
      "message": 1
    },
    "delivered": false,
    "delivered_at": null,
    "valid_until": null,
    "created_at": "2019-04-05T08:26:58.765Z",
    "volatile": false
  },
  "meta": {}
}

Client Errors

Name Description
400_Bad_Request

uuid not valid
401_Unauthorized
403_Forbidden

user message does not belong to authenticated organization
404_Not_Found

user message does not exist

LTE | Get device events

Get Device Events for LTE beacons

get 
https://cloud.estimote.com/v3/lte/device_events

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/lte/device_events?identifier=YOUR_DEVICE_IDENTIFIER' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/lte/device_events?app_id=YOUR_APP_ID' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
curl -X GET 'https://cloud.estimote.com/v3/lte/device_events?app_id=YOUR_APP_ID'&min_release=1 -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Query Parameter

Field Type Description
identifier String

(either identifier or app_id is required)
app_id String

(either identifier or app_id is required)
type String
page Number

page size is 100

Default value: 1
since Number

javascript timestamp, if provided will fetch only events newer than since value
app_release Number[]

if provided will only fetch events from specified release/releases. Use "latest" to match the newest release for app
min_release Number

if provided will fetch device events for app releases greater or equal (0 release is Daft, next releases are sequential)
max_release Number

if provided will fetch device events for app releases smaller or equal

Success 200

Field Type Description
data Array

array of device events ordered by received_at, where newest event is first
  type String

type of event (first parameter used when performing cloud.enqueue)
  payload Object

user-defined payload
  enqueued_at String

DateTime when event was pushed to LTE Beacon outgoing queue
  received_at String

DateTime when event was processed the Cloud time
  device_identifier String

identifier of device that sent the event
meta Object
  page Number

current page (page size is 100)
  total Number

total number of device events that meet the filtering criteria
  app_id optional String

filtered app_id (if provided as query parameter)
  identifier optional Number

filtered identifier (if provided as query parameter)
  type optional String

filtered type (if provided as query parameter)
  until optional Number

javascript timestamp of newest received_at value of events matching query
  app_release optional Number[]

javascript timestamp of newest received_at value of events matching query

 
HTTP/1.1 201 OK

{
  "data": [
    {
      "type": "ble_scan_completed",
      "payload": {
        "ble_devices": 11
      },
      "enqueued_at": "2018-10-05T13:21:17.000Z",
      "device_identifier": "8a7e72fd0b6b7a43699658accc6f5335",
      "received_at": "2018-10-05T13:21:32.087Z",
      "app_release": 0,
      "app_id": "blank-8asne63"
    },
    {
      "type": "ble_scan_started",
      "payload": {
        "ble_devices": 2
      },
      "enqueued_at": "2018-10-05T13:21:02.000Z",
      "device_identifier": "8a7e72fd0b6b7a43699658accc6f5335",
      "received_at": "2018-10-05T13:21:16.722Z",
      "app_release": 1,
      "app_id": "blank-8asne63"
    }
  ],
  "meta": {
    "page": 1,
    "total": 62
  }
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
403_Forbidden

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

LTE | Get list of user messages

Get list of user messages

get 
https://cloud.estimote.com/v3/lte/user_messages

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/lte/user_messages?device_identifier=YOUR_DEVICE_IDENTIFIER&type=YOUR_TYPE' \
-u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Query

Field Type Description
device_identifier optional String

will get only messages for specified device
type optional String

will get only messages of specified type
delivered optional Boolean

will get only messages of specified delivered status
page optional Number

pagination parameter

 
HTTP/1.1 200 OK
{
  "data": [
    {
      "uuid": "f44c586a-2f18-4b3c-898b-6c759617d5e5",
      "device_identifier": "YOUR_DEVICE_IDENTIFIER",
      "type": "YOUR_TYPE",
      "payload": {
        "message": 1
      },
      "delivered": false,
      "delivered_at": null,
      "valid_until": null,
      "created_at": "2019-04-05T08:25:37.922Z",
      "volatile": false
    },
    {
      "uuid": "1c698cae-e215-4dec-90d1-7649ec2ebf62",
      "device_identifier": "YOUR_DEVICE_IDENTIFIER",
      "type": "YOUR_TYPE",
      "payload": {
        "message": 1
      },
      "delivered": false,
      "delivered_at": null,
      "valid_until": null,
      "created_at": "2019-04-05T08:26:58.765Z",
      "volatile": false
    }
  ],
  "meta": {
    "page": 1,
    "total": 2
  }
}

Client Errors

Name Description
400_Bad_Request

query not valid
401_Unauthorized
403_Forbidden

specified device does not belong to authenticated organization
404_Not_Found

specified device does not exist

LTE | Get user message

Get user message

get 
https://cloud.estimote.com/v3/lte/user_messages

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/lte/user_messages/YOUR_USER_MESSAGE_UUID' \
-u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN

Url

Field Type Description
uuid String

v4 of user message

 
HTTP/1.1 200 OK
{
  "data": {
    "uuid": "YOUR_USER_MESSAGE_UUID",
    "device_identifier": "e073ba800c471b622870fa87199ab52b",
    "type": "MY_TYPE",
    "payload": {
      "message": 1
    },
    "delivered": false,
    "delivered_at": null,
    "valid_until": null,
    "created_at": "2019-04-05T08:26:58.765Z",
    "volatile": false
  },
  "meta": {}
}

Client Errors

Name Description
400_Bad_Request

uuid not valid
401_Unauthorized
403_Forbidden

user message does not belong to authenticated organization
404_Not_Found

user message does not exist

Mesh Network

Estimote Low-Power BLE network enables direct interaction between Estimote devices over Bluetooth LE. Network is based on mesh topology working in both flooded and routed modes. Network is used to exchange firmware updates and device configurations.

How it works: Information about firmware update or configuration change is propagated over the mesh using structured messages. Messages are generated by Estimote Cloud when any change is detected. Messages are then automatically injected to the network during BLE connection to any devices belonging to the network. Connection can be established by iOS/Android Estimote Apps or custom ones using Estimote SDK. When message is propagated over the network each device is updating broadcasted settings version of the last seen message after consuming it. At this stage propagation of the message needs to be confirmed in Estimote Cloud. This operation can be easily performed using Estimote SDK on iOS or Android.

Mesh Network | Add devices to mesh network

Add devices to already existing mesh network. Request alone does not enable mesh capabilities on the device. It generates pending settings for mesh advertiser that need to be synchronized with the actual device over Bluetooth LE.

Note: If Mesh is a cluster type, then all devices will have to be connected as their schedule time has to be recalculated.

post 
https://cloud.estimote.com/v3/mesh/:mesh_identifier/devices

Permission: public 

curl -X POST https://cloud.estimote.com/v3/mesh/888/devices -H "Content-Type: application/json"

Body parameters

Field Type Description
devices Array

Identifiers of the devices that should be added to the mesh network.

 
{
    "devices": [
        "7e9c24b2f6027f6cd0c6eb2429bd602a"
    ]
}
HTTP/1.1 200 OK
{
 "data": {
   "successes":["7e9c24b2f6027f6cd0c6eb2429bd602a"],
   "errors":[]
 }
}

Client Errors

Name Description
400_Bad_Request

Device(s) doesn't support Mesh.
401_Unauthorized

Connection credentials are incorrect.
404_No_Found

Mesh with specified identifier doesn't exist.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Mesh Network | Confirm device's settings version

Confirm device pending settings as current settings. This method works alike for all mesh versions (whether it be classic or routed, standard or clustered). If the settings version on pending settings matches its POSTed counterpart, cloud assumes that latest settings were propagated across mesh, thus pending settings are automatically converted into settings.

post 
https://cloud.estimote.com/v3/mesh/confirm

Permission: public 

curl -X POST https://cloud.estimote.com/v3/mesh/confirm -H "Content-Type: application/json"

Body parameters

Field Type Description
identifier String

Identifier of the device to update.
settings_version Number

Timestamp of last seen message.

 
[
    {
        "identifier": "ae7b6725abe877f16c44fc58a261cd3e",
        "settings_version": 1423534654
    }
]
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
   "successes":["ae7b6725abe877f16c44fc58a261cd3e"],
   "errors":[]
  }
}

Client Errors

Name Description
400_Bad_Request

Request body is malformed or in incorrect format

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Mesh Network | Create mesh network

Creates a new mesh network. Network defines set of devices able to communicate directly between each other.

Note: Current implementation returns devices added to mesh in devices key in response body. However, when meshes are fetched via GET /v2/mesh, it only displays beacons that are in mesh (i.e. mesh advertiser in settings is enabled), thus when mesh has just been created getting meshes will return an empty result for that particular one. To be fixed in next implementation.

post 
https://cloud.estimote.com/v3/mesh

Permission: public 

curl -X POST https://cloud.estimote.com/v3/mesh -H "Content-Type: application/json"

Body parameters

Field Type Description
mesh_name String

Name of newly created mesh network.
mesh_type String

Type of the network. Available values are standard and cluster. Standard network enables basic exchange of messages (configuration and firmware) between devices. All devices can be configured/updated independently. Cluster network allows to extend battery life of a single beacon by grouping it with another beacon. All devices in cluster network share the same advertiser settings. Only single device is broadcasting desired packets at the time.
devices Array

Identifiers of the devices that will belong to created mesh network.

 
{
    "mesh_name": "Mesh network #1",
    "mesh_type": "standard",
    "devices": [
        "6e9c34b2f6087f6cb0c6eb2420bd602a",
        "5515e4f5f27b10f22cf88e8f0992962c"
    ]
}
HTTP/1.1 200 OK
{
  "meta": {},
  "data": {
   "mesh_identifier": 56438,
   "mesh_name": "Mesh network #1",
   "type": "standard",
   "devices": ["6e9c34b2f6087f6cb0c6eb2420bd602a", "5515e4f5f27b10f22cf88e8f0992962c"],
   "pending_devices": ["6e9c34b2f6087f6cb0c6eb2420bd602a", "5515e4f5f27b10f22cf88e8f0992962c"]
 }
}

Client Errors

Name Description
400_Bad_Request

Device doesn't support Mesh.
401_Unauthorized

Connection credentials are incorrect.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Mesh Network | Get all mesh networks

Get list of all mesh networks that belong to the user. Each network is delivered in the similar way as in /v3/mesh/:mesh_identifier request.

get 
https://cloud.estimote.com/v3/mesh

Permission: public 

curl -X GET https://cloud.estimote.com/v3/mesh
HTTP/1.1 200 OK
{
 "meta": {},
 "data": [
       {
         "mesh_name": "Mesh network #1",
         "mesh_identifier": 56438,
         "type": "standard",
         "devices": [
           "e289240e0b076e6a5bd1914f3ac94b0f",
           "c69fed339e5119d3bfa9a496e400c70a"
         ],
         "devices_for_update": []
       },
       {
         "mesh_name": "Mesh network #2",
         "mesh_identifier": 56439,
         "type": "standard",
         "devices": [
           "ae7b6725abe877f16c44fc58a261cd3e",
           "4b34d045a8fd3c6cbbc3e82e68a52d14"
         ],
         "devices_for_update": [
           "4b34d045a8fd3c6cbbc3e82e68a52d14"
         ]
       }
     ]
   }

Client Errors

Name Description
401_Unauthorized

Connection credentials are incorrect

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Mesh Network | Get mesh devices.

Get devices from given mesh.

get 
https://cloud.estimote.com/v3/mesh/:mesh_identifier/devices

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/mesh/100/devices' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Parameter

Field Type Description
mesh_identifier Integer

Mesh identifier.

Query Parameter

Field Type Description
page optional Integer

From which page data should be returned. Default value is 1.
device_type optional String

List of device type which will be returned. Device types can be beacon, mirror or sticker. Default value beacon,mirror,sticker.

 
  HTTP/1.1 200 OK
  {
    "meta": {
      "total_count": 1,
      "page": 1
    },
    "data": [{
      "identifier": "046618f76a44404af14a546e7a37ac3b",
      "shadow": {
        "id": 498,
        "name": "white beacon",
        "tags": [
          "cat"
        ],
        "organization_id": 4036,
        "location": {
          "timezone": "America/Los_Angeles",
          "location_id": 2512,
          "country": "United States",
          "zipcode": null,
          "state": "Alaska",
          "state_code": "AK",
          "city": null,
          "street_name": null,
          "street_number": null,
          "formatted_address": "Devils Desk, Alaska, USA",
          "latitude": 58.4756,
          "longitude": -154.2981
        },
        "indoor_location": {
          "name": "test",
          "identifier": "indoor_test"
        },
        "development_mode": false
      },
      "alerts_configuration": {
        "beacon_stolen_notifications": "off",
        "beacon_fallen_notifications": "off",
        "beacon_battery_notifications": "off",
        "updated_at": "2017-01-30T12:26:10.777Z"
      },
      "alerts": [],
      "hardware_type": "beacon",
      "hardware_revision": "F2.2",
      "hardware_footprint": "165562dd94797b6027cf920b5a1831cbc6a7f25c",
      "color": "white",
      "form_factor": "standard",
      "status_report": {
        "battery_percentage": 95,
        "battery_voltage": 5526,
        "estimated_battery_lifetime": 627,
        "firmware_version": "4.7.0",
        "last_synced": "2017-02-20T12:58:46.375Z",
        "public": false,
        "broken_motion": false,
        "broken_temperature": false,
        "missing_telemetry_data": false
      },
      "settings": {
        "general": {
          "motion_detection_enabled": true,
          "motion_only_enabled": false,
          "dark_to_sleep_enabled": false,
          "dark_to_sleep_threshold": 300,
          "conditional_broadcasting": "off",
          "flip_to_sleep_enabled": false,
          "smart_power_mode_enabled": true,
          "temperature_offset": 0,
          "eddystone_configuration_service_enabled": false,
          "nfc_records": [{
            "data": "com.estimote.apps.main",
            "type": "android_package"
          }],
          "automatic_firmware_update_enabled": false,
          "motion_only_delay": 0,
          "schedule": {
            "enabled": false,
            "start_time": 190,
            "stop_time": 1050
          },
          "wifi": {
            "enabled": true,
            "ssid": "exampleNetwork",
            "password": "aPassThrough"
          },
          "templates": {
            "default_template": "default",
            "lock_template": false
          },
          "estimote_secure_monitoring": {
            "enabled": false,
            "krps": 8,
            "prps": 16,
            "seed": "a7714d65d9f27e1116f3539764146cfc"
          }
        },
        "advertisers": {
          "connectivity": [{
            "index": 1,
            "name": "connectivity",
            "power": -12,
            "interval": 500,
            "shake_to_connect_enabled": false,
            "near_to_connect_enabled": true
          }],
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48025,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "eddystone_eid": [{
            "index": 1,
            "name": "Eddystone EID",
            "enabled": true,
            "interval": 100,
            "power": -30,
            "identity_key": "0123456789abcdef0123456789abcdef",
            "interval_scaler": 10,
            "registered_namespace_id": null,
            "registered_instance_id": null
          }],
          "eddystone_url": [{
            "index": 1,
            "name": "Eddystone URL",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "url": "http://go.esti.be/"
          }],
          "eddystone_telemetry": [{
            "index": 1,
            "name": "Eddystone Telemetry",
            "enabled": false,
            "interval": 950,
            "power": -12
          }],
          "estimote_telemetry": [{
            "index": 1,
            "name": "Estimote Telemetry",
            "enabled": true,
            "interval": 950,
            "power": -12
          }],
          "estimote_location": [{
            "index": 1,
            "name": "Estimote Location",
            "enabled": true,
            "interval": 500,
            "power": 0
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "link_id": null,
            "domain": null,
            "measurement_period": 60
          }],
          "mesh": [{
            "index": 1,
            "name": "Mesh",
            "enabled": true,
            "settings_sync_enabled": false,
            "firmware_sync_enabled": false,
            "interval": 950,
            "settings_version": null,
            "mesh_identifier": 123,
            "mesh_key": "00000000000000000000000000000000",
            "synchronisation_list": [
              "00B0",
              "00B1",
              "00B8",
              "00B9",
              "0100",
              "0200",
              "0300",
              "0101",
              "0201",
              "0301",
              "0102",
              "0202",
              "0302",
              "0103",
              "0203",
              "0303",
              "2001",
              "2002",
              "2003",
              "2004",
              "2006"
            ]
          }]
        },
        "gpio": {
          "config_0": 0,
          "config_1": 0,
          "config_2": 0,
          "config_3": 0,
          "port_data": 0,
          "interrupt_enabled": false,
          "gpio_0_state_led_indicator_enabled": false
        }
      },
      "pending_settings": {
        "advertisers": {
          "ibeacon": [{
            "index": 1,
            "name": "iBeacon",
            "enabled": true,
            "uuid": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAABB",
            "major": 48024,
            "minor": 15325,
            "power": -12,
            "interval": 950,
            "security": {
              "enabled": true,
              "real_id": 1034243,
              "interval_scaler": 10
            },
            "non_strict_mode_enabled": true
          }],
          "eddystone_uid": [{
            "index": 1,
            "name": "Eddystone UID",
            "enabled": false,
            "interval": 950,
            "power": -12,
            "instance_id": "046618f76a44",
            "namespace_id": "eddd1ebeac04e5defa99"
          }],
          "link_network": [{
            "index": 1,
            "name": "Here & Now",
            "enabled": true,
            "interval": 950,
            "power": -12,
            "link_id": 52476,
            "domain": "https://www.est1.net/",
            "measurement_period": 60
          }]
        }
      },
      "mesh": {
        "name": null,
        "type": null
      },
      "type": "device"
  }]
}

Client Errors

Name Description
400_Bad_Request

Your request did not follow the required format. Please consult the documentation at cloud.estimote.com/docs
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  errors: [
    {
      status: 400,
      code: "query_param_not_valid",
      path: "page",
      title: "page not valid",
      message: ""page" must be a positive number"
    }
  ]
}

Mesh Network | Get mesh network

Get details of network represented by given identifier.

get 
https://cloud.estimote.com/v3/mesh/:mesh_identifier

Permission: public 

curl -X GET https://cloud.estimote.com/v3/mesh/888

Query parameters

Field Type Description
mesh_identifier String

Identifier of the mesh network details should be fetched for.

 
HTTP/1.1 200 OK
{
 data: {
       "mesh_name": "Mesh network #1",
       "mesh_identifier": 56438,
       "type": "standard",
       "devices": [
         "e289240e0b076e6a5bd1914f3ac94b0f",
         "c69fed339e5119d3bfa9a496e400c70a"
       ],
       "devices_for_update": []
     }
   }

Client Errors

Name Description
401_Unauthorized

Connection credentials are incorrect
404_No_Found

Mesh with specified identifier doesn't exist

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Mesh Network | Override mesh lock

Clear lock for a mesh.

post 
https://cloud.estimote.com/v3/mesh/:mesh_identifier/override_lock

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/mesh/100/override_lock' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Content-Type: application/json" -d \
'{
  "confirm_override": true
}'

Parameter

Field Type Description
mesh_id Integer

Mesh identifier.

 
HTTP/1.1 200 OK
{
  "meta": {
  },
  "data": true
}

Client Errors

Name Description
400_Invalid_Body

'confirm_override: true' should be provided in request body
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_No_Found

Mesh with specified identifier doesn't exist

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  "errors": [
    {
      "status": 400,
      "code": "unknown_error",
      "title": "Unknown Error",
      "message": "Unknown_Error"
    }
  ]
}

Mesh Network | Remove device from mesh network

Remove specified device(s) from mesh network. Request alone does not disable mesh capabilities in the device. It generates pending settings for mesh advertiser that need to be synchronized with the actual device over Bluetooth LE.

Note: If Mesh is a cluster type, then all devices will have to be connected as their schedule time has to be recalculated.

delete 
https://cloud.estimote.com/v3/mesh/:mesh_identifier/devices

Permission: public 

curl -X DELETE https://cloud.estimote.com/v3/mesh/:mesh_identifier/devices -H "Content-Type: application/json"

Body parameters

Field Type Description
devices Array

Identifiers of the devices that should be removed from the mesh network.

 
{
    "devices": [
        "6e9c34b2f6087f6cb0c6eb2420bd602a"
    ]
}
HTTP/1.1 200 OK
{
  "data": {
   "successes":["6e9c34b2f6087f6cb0c6eb2420bd602a"],
   "errors":[]
  }
}

Client Errors

Name Description
401_Unauthorized

Connection credentials are incorrect.
404_No_Found

Mesh with specified identifier doesn't exist.

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception.

Orders

Orders | Get all orders

Fetch orders from Santacruz

get 
https://cloud.estimote.com/v1/orders
http://localhost:3000/v1/orders?type=devkit

URL Parameter

Field Type Description
type optional String

Type of orders ['bulkbag','devkit','stickers']

 
HTTP/1.1 200 OK
[
  {
    "created_at": "2016-09-18T14:01:40.273Z",
    "state_for_customer": "shipping",
    "url": "http://localhost:3000/orders/bdddae0d877618b976965b0ebc0ca3c6",
    "state": "ready_to_label",
    "item": {
      "summary": "1 Dev kit of 10 stickers",
      "symbol": "stickers",
      "identifier": "stickers_dev_kit_2014",
      "options": {},
      "quantity": 1,
      "item_type_quantity": 10,
      "name": "Stickers dev kit 2014",
      "label": "Estimote Stickers Developer Kit"
    },
    "items": [{
      "summary": "1 Dev kit of 10 stickers",
      "symbol": "stickers",
      "identifier": "stickers_dev_kit_2014",
      "options": {},
      "quantity": 1,
      "item_type_quantity": 10,
      "name": "Stickers dev kit 2014",
      "label": "Estimote Stickers Developer Kit"
    }, {
      "summary": "3 Dev kits of 3 location beacons",
      "symbol": "location_devkit",
      "identifier": "location_dev_kit_2016",
      "options": {},
      "quantity": 3,
      "item_type_quantity": 3,
      "name": "Location dev kit 2016",
      "label": "Estimote Development Kit with Location Beacons"
    }, {
      "summary": "5 Dev kits of 3 proximity beacons",
      "symbol": "devkit",
      "identifier": "proximity_dev_kit_mid_2016",
      "options": {},
      "quantity": 5,
      "item_type_quantity": 3,
      "name": "Proximity dev kit (Mid 2016)",
      "label": "Estimote Development Kit with Proximity Beacons"
    }]
  }
]

401 Unauthorized

Name Description
notAuthorizedError

Not authorized

500 Internal Server Error

Name Description
internalServerError

Unable to the handle request due to exception.

SantaCruz

SantaCruz | Assign trial subscription plan to user

get 
https://cloud.estimote.com/santacruz/santacruz/set_trial_plan

Parameter

Field Type Description
email String

Users unique email.
planTypeIdentifier String

Subscription plan identifier.
days Number

Number of days

 
HTTP/1.1 200 OK
{
 "status": "ok"
}

400

Name Description
missingParamsError

Missing required body params

401

Name Description
notAuthorizedError

Unauthorized

404

Name Description
notFoundError

User with given email was not found

500

Name Description
serverError

Error during processing request

SantaCruz | Create Estimote Cloud Account

Require authentications. Create user, organization and send invitation email to user.

post 
https://cloud.estimote.com/santacruz/add

Request body

Field Type Description
email String

Email for creating account
name optional String

Name of user, if not exists the email is assigned to user name

Success 200

Field Type Description
status String

OK if beacon has been successfully added.
token String

to set password

 
HTTP/1.1 200 OK
{
 "status": "ok"
 "token": "abctoken123"
}

401

Name Description
serverError

Unauthorized

403

Name Description
serverError

Account exists for this email

412

Name Description
serverError

Missing required params(email)

500

Name Description
serverError

Other Error

SantaCruz | Get available trial subscriptions plans

get 
https://cloud.estimote.com/santacruz/trial_plans
HTTP/1.1 200 OK
{
    "data": {
        "plans": [
            {
                "name": "Deployment",
                "price": 5988,
                "item_type_identifier": "deployment_subscription",
                "addons": [
                    "web_dashboard",
                    "estimote_app",
                    "mobile_sdk",
                    "indoor",
                    "deployment_tools",
                    "hereandnow",
                    "remote_beacon_configuration",
                    "fleet_management"
                ],
                "min": 20,
                "max": 199
            },
            {
                "name": "Super Enteprise",
                "price": 9999,
                "item_type_identifier": "super_enterprise",
                "addons": [
                    [
                        "web_dashboard"
                    ]
                ],
                "min": 256,
                "max": 99998
            },
            {
                "name": "Pilot",
                "price": 1548,
                "item_type_identifier": "pilot_subscription",
                "addons": [
                    "web_dashboard",
                    "estimote_app",
                    "mobile_sdk",
                    "indoor",
                    "deployment_tools"
                ],
                "min": 0,
                "max": 18
            }
        ]
    }
}

401

Name Description
notAuthorizedError

Unauthorized

500

Name Description
serverError

Error during processing request

SantaCruz | Get base_order_it for given email

If Santa Cruz can't find parent order in its database, it asks Cloud for base_order_id of an account with given email.

get 
https://cloud.estimote.com/santacruz/get_base_order_id/:email

Parameter

Field Type Description
email String

Users unique email.

 
HTTP/1.1 200 OK
{
 "base_order_id": 100
}

401

Name Description
notAuthorizedError

Unauthorized

404

Name Description
notFoundError

User with given email was not found

500

Name Description
serverError

Error during processing request

SantaCruz | Get user saas status

get 
https://cloud.estimote.com/santacruz/users/:email/saas_status

Parameter

Field Type Description
email String

Users unique email.

 
HTTP/1.1 200 OK
{
    "data": {
        "grants": [
            {
                "addon": "web_dashboard",
                "expires_at": null
            },
            {
                "addon": "estimote_app",
                "expires_at": null
            },
            {
                "addon": "fleet_management",
                "expires_at": null
            },
            {
                "addon": "deployment_tools",
                "expires_at": null
            },
            {
                "addon": "hereandnow",
                "expires_at": null
            },
            {
                "addon": "mobile_sdk",
                "expires_at": null
            },
            {
                "addon": "analytics",
                "expires_at": null
            },
            {
                "addon": "infrastructure_sharing",
                "expires_at": null
            },
            {
                "addon": "api",
                "expires_at": null
            },
            {
                "addon": "security",
                "expires_at": null
            },
            {
                "addon": "remote_beacon_configuration",
                "expires_at": null
            },
            {
                "addon": "indoor",
                "expires_at": null
            },
            {
                "addon": "oauth",
                "expires_at": null
            }
        ],
        "subscriptionPlan": {
            "item_type_identifier": "prototyping_subscription",
            "created_at": "2017-07-17T12:47:55.294Z",
            "paid_until": null,
            "is_trial": false
        }
    }
}

400

Name Description
missingParamsError

Missing required body params

401

Name Description
notAuthorizedError

Unauthorized

404

Name Description
notFoundError

User with given email was not found

500

Name Description
serverError

Error during processing request

SantaCruz | List of all cloud users

Returns array with all Cloud users + beacons count. Requires authentication as SantaCruz

get 
https://cloud.estimote.com/santacruz/users/

QueryString

Field Type Description
query String

Search query
page Integer

Page number you want to fetch

Success 200

Field Type Description
users Array
  email String

User login
  name String

User Name
  beacons_count String

Number of beacons associated with user
  is_beta Boolean

Determines whether user has access Beta features
  is_admin Boolean

Determines whether user has admin access
  features Object

Shows both enabled and disabled features

 
HTTP/1.1 200 OK
{
  users: [
  {
    "email": "tester@estimote.com",
    "name" : "Super Tester",
    "is_admin": false,
    "is_beta": false,
    "beacons_count": 3,
    "features": {
      "analytics": false,
      "cms": true
    }
  }
  ],
  page: 2,
  perPage: 50,
  totalCount: 1337
}

500

Name Description
serverError

Error during processing request

SantaCruz | Reset password for given user

post 
https://cloud.estimote.com/santacruz/users/:email/reset_password

Parameter

Field Type Description
email String

Users unique email.

 
HTTP/1.1 200 OK
{
 "status": "ok",
 "reset_url": "https://cloud.estimote.com/users/setPassword/aabbccddeeffaabbccddeeff"
}

401

Name Description
notAuthorizedError

Unauthorized

500

Name Description
serverError

Error during processing request

SantaCruz | Set new device color

Set new device color. Requires authentication.

post 
https://cloud.estimote.com/santacruz/device/:identifier/color

Parameter

Field Type Description
identifier String

[Request param] Device identifier
color String

[Body param] New device color

Success 200

Field Type Description
status String

OK if color has been successfully set.

 
HTTP/1.1 200 OK
{
 "status": "ok"
}

401

Name Description
notAuthorizedError

Unauthorized

404

Name Description
notFoundError

Device with given identifier was not found

412

Name Description
missingParamsError

Device identifier or color is missing

500

Name Description
serverError

Error during processing request

Scan Reports

Scan Reports | Get scan report

Get scan reports from Cloud with a particular report ID.

get 
https://cloud.estimote.com/v3/asset_tracking/reports/:report_id

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/asset_tracking/reports/4' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"

Parameter

Field Type Description
report_id String

Report ID.

 
HTTP/1.1 200 OK
{
  "meta": {
    "total_count": 1
  },
  "data": {
    "devices_reports": {
      "704ec0365d565264e84b2c02bc83522c": [
        {
          "seen_nearable": "79ad3add",
          "rssi": -58
        },
        {
          "seen_nearable": "3d6d786f",
          "rssi": -80
        }
      ]
    },
    "settings_version": 1507040724,
    "collected_at": 1507040724,
    "report_id": 4
  }
}

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps
404_No_Found

Report with specified identifier doesn't exist

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  "errors": [
    {
      "status": 400,
      "code": "unknown_error",
      "title": "Unknown Error",
      "message": "Unknown_Error"
    }
  ]
}

Scan Reports | Get scan reports

Get all scan reports from Cloud for a user. Reports will be returned in an array.

get 
https://cloud.estimote.com/v3/asset_tracking/reports

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/asset_tracking/reports' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json"
HTTP/1.1 200 OK
{
  "meta": {
    "total_count": 1
  },
  "data": {
    "devices_reports": [
    {
      "704ec0365d565264e84b2c02bc83522c": [
        {
          "seen_nearable": "79ad3add",
          "rssi": -58
        },
        {
          "seen_nearable": "3d6d786f",
          "rssi": -80
        }
      ]
    },
    "settings_version": 1507040724,
    "collected_at": 1507040724,
    "report_id": 4
  }
}
]

Client Errors

Name Description
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  "errors": [
    {
      "status": 400,
      "code": "unknown_error",
      "title": "Unknown Error",
      "message": "Unknown_Error"
    }
  ]
}

Scan Reports | Send scan reports

Upload scan reports to Cloud and store them. A report consists of hex strings with short device IDs and nearables that were heard by the device along with their rssi.

post 
https://cloud.estimote.com/v3/asset_tracking/reports

Permission: public 

curl -X POST 'https://cloud.estimote.com/v3/asset_tracking/reports' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN -H "Accept: application/json" -d
{
"settings_version": 1507040706,
"collected_at": 1507040789,
"report": ["704ec03679ad3addc6", "704ec0363d6d786fb079ad3addc2"],
}

Parameter

Field Type Description
settings_version Integer

Settings Version.
collected_at Integer

Time of collection (timestamp).
report Array

Array of hexed report elements.

 
HTTP/1.1 200 OK
{
  "meta": {
  },
  "data": {
    "success": true
  }
}

Client Errors

Name Description
400_Invalid_Body

One or more of the parameters are invalid
401_Unauthorized

Incorrect credentials provided, please authenticate with the App ID and App Token obtained at cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 400 Bad Request
{
  "errors": [
    {
      "status": 400,
      "code": "unknown_error",
      "title": "Unknown Error",
      "message": "Unknown_Error"
    }
  ]
}

Stickers

Stickers | Reassign (transfer) stickers

Reassign (transfer) stickers to another account.

post 
https://cloud.estimote.com/v1/stickers/reassign
{
"identifiers": [
"c7c3f4002940c7c3f4002940",
"c232ef34c5a0c232ef34c5a0",
"c382e96c7cadc382e96c7cad"
    ],
    "email": "receiver@example.com"
}

Request body

Field Type Description
identifiers String[]

Stickers' identifiers
email String

Destination (receiver) account, identified by email address

400 Bad Request

Name Description
badRequest

Some of the parameters are missing

401 Unauthorized

Name Description
notAuthorizedError

Not authorized

403 Forbidden

Name Description
forbiddenError

Try to assign not own stickers

404 Not Found

Name Description
notFoundError

New owner not found

409 Conflict

Name Description
conflict

Account of new owner is not active

500 Internal Server Error

Name Description
internalServerError

Unable to handle the request due to an exception

Tags

Tags | Get identifiers by tag

Gets identifiers of devices that have given tag

get 
https://cloud.estimote.com/v3/tags/devices

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/tags/devices?name=hello' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN'
curl -X GET 'https://cloud.estimote.com/v3/tags/devices?name=world' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN'

Query Parameter

Field Type Description
name String

tag name

 
HTTP/1.1 200 OK
{
 "data": {
    "identifiers":[
       "YOUR_DEVICE_IDENTIFIER_A",
       "YOUR_DEVICE_IDENTIFIER_B",
       "YOUR_DEVICE_IDENTIFIER_C"
    ],
    "tag": {
       "id": 12,
       "name": "hello",
       "created_at": "2018-05-07T14:43:10.458Z",
       "updated_at": "2018-05-07T14:43:10.458Z"
    }
 },
 "meta": {}
}
HTTP/1.1 200 OK
{
 "data": {
    "identifiers":[],
    "tag": {
       "id": 13,
       "name": "world",
       "created_at": "2018-05-07T15:43:10.458Z",
       "updated_at": "2018-05-07T15:43:10.458Z"
    }
 },
 "meta": {}
}

Client Errors

Name Description
400_Bad_Request

Incorrect request format
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps
404_Not_Found

Tag not found

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

 
HTTP/1.1 404 Not Found
{
  errors: [
    {
      status: 404,
      code: "Not Found",
      message: "Tag not found"
    }
  ]
}

Tags | Get tags

Gets tags list with pagination

get 
https://cloud.estimote.com/v3/tags

Permission: public 

curl -X GET 'https://cloud.estimote.com/v3/tags' -u YOUR_SDK_APP_ID:YOUR_SDK_APP_TOKEN'

Query Parameter

Field Type Description
page optional Integer

Default value: 1

 
HTTP/1.1 200 OK
{
  "meta": {
       "page": 1,
       "total_count": 3
   },
  "data": [
    {
        "id": 539,
        "name": "ąę",
        "created_at": "2018-05-07T14:43:10.458Z",
        "updated_at": "2018-05-07T14:43:10.458Z"
    },
    {
        "id": 513,
        "name": "cafe",
        "created_at": "2017-09-29T10:06:39.687Z",
        "updated_at": "2017-09-29T10:06:39.687Z"
    },
    {
        "id": 511,
        "name": "clothes",
        "created_at": "2017-09-29T10:05:24.173Z",
        "updated_at": "2017-09-29T10:05:24.173Z"
    }
  ]
}

Client Errors

Name Description
400_Bad_Request

Incorrect request format
401_Unauthorized

Incorrect credentials provided, to find YOUR_SDK_APP_ID and YOUR_SDK_APP_TOKEN visit https://cloud.estimote.com/#/apps

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to an server exception. Try again later and contact us at contact@estimote.com if the problem persists

Telemetry

Telemetry | Store telemetry readings

Stores all telemetry readings captured from broadcasting devices.

post 
https://cloud.estimote.com/v3/telemetry
{
  "data": [
    {
      "identifier": "5ca1ab1e5eed",
      "acceleration": {
        "x": -0.12,
        "y": 0.53,
        "z": 0.12
      },
      "magnetic_field": {
        "x": 0.11,
        "y": 0.22,
        "z": 0.33
      },
      "motion": {
        "current_state": true,
        "current_state_duration": 120,
        "previous_state_duration": 314
      },
      "temperature": 18,
      "ambient_light_level": 999,
      "battery_voltage": 1.1,
      "uptime": 13020,
      "warnings": {
        "application_error": true,
        "rtc_error": false
      },
      "scanned_at": 1445288585
    }
  ]
}

Request body

Field Type Description
data Array

Each hash in the Array contains readings from one device
  identifier String

Identifier of the device
  acceleration Object

Readings from accelerometer
    x Number

Accelerometer data related to X axis
    y Number

Accelerometer data related to Y axis
    z Number

Accelerometer data related to Z axis
  magnetic_field Object

Readings related to magnetic field
    x Number

Strength of magnetic field in X axis. Normalized to (-1, 1) range.
    y Number

Strength of magnetic field in Y axis. Normalized to (-1, 1) range.
    z Number

Strength of magnetic field in Z axis. Normalized to (-1, 1) range.
  motion Object

Readings related to motion state of device
    current_state Boolean

Current motion state of device. True if in motion, False if not.
    current_state_duration Number

Duration of the current motion state in seconds.
    previous_state_duration Number

Duration of the previous motion state in seconds.
  temperature Number

Ambient temperature of device in Celsius degree.
  ambient_light_level Number

Level of device ambient light in Lux.
  battery Number

Battery level in %.
  battery_voltage Number

Battery voltage in millivolts.
  uptime Number

Uptime since last reboot in seconds.
  warnings Object
    application_error Boolean

A flag indicating that there has been some error leading to device restart
    rtc_error Boolean

A flag indicating that Real Time Clock had some problems and should be synchronized.
  packet_count Number

Count of packets sent by the device since last reboot
  scanned_at Integer

Timestamp indicating when the reading has been received(in milliseconds).

 
HTTP/1.1 200 OK
{
  "data": {
     "success": true
  },
  "meta": {}
}

Client Errors

Name Description
400_Bad_request

Invalid request body

Server Errors

Name Description
500_Internal_Server_Error

Unable to handle the request due to a server exception. Try again later and contact us at contact@estimote.com if the problem persists

Users

Users | Create Estimote Cloud Account

Require authentications. Create user, organization and send setup account email to user.

post 
https://cloud.estimote.com/v1/users/create

Request body

Field Type Description
email String

Email for creating account
name optional String

Name of user, if not exists the email is assigned to user name

Success 200

Field Type Description
status String

OK if beacon has been successfully added.
token String

to set password

 
HTTP/1.1 200 OK
{
  "status": "ok"
  "token": "abctoken123"
}

401

Name Description
serverError

Unauthorized

403

Name Description
serverError

Account exists for this email

412

Name Description
serverError

Missing required params(email)

500

Name Description
serverError

Other Error

Users | Get email hint

Require authentications. Returns email hint for given Beacon's mac address.

get 
https://cloud.estimote.com/v1/users/email_hint/:mac

URL Parameter

Field Type Description
mac String

Beacon's MAC address

 
HTTP/1.1 200 OK
{
  "hint": "j****.a***@e***.c**"


}

401

Name Description
serverError

Unauthorized

404

Name Description
serverError

Not found

502

Name Description
serverError

SantaCruz error

Users | Remove user

Require SantaCruz authentications. Removes user with all dependencies.

delete 
https://cloud.estimote.com/v1/users/:email

URL Parameter

Field Type Description
email String

User's email

 
HTTP/1.1 200 OK
{
  "status": "ok"
}

401

Name Description
serverError

Unauthorized

404

Name Description
serverError

Not found

500

Name Description
serverError

Internal server error - see cloud logs