1. Home
  2. Docs
  3. AnalyticsOS – Cloud API Documentation v.1.0
  4. GPS Data v1

GPS Data v1

[bt_bb_section layout=”boxed_1200″ lazy_load=”yes” show_boxed_content=”no” allow_content_outside=”no”][bt_bb_row][bt_bb_column lazy_load=”yes” highlight=”no” align_to_edge_column=”no” width=”1/1″][bt_bb_text] Overview
GPS data can be sent to AnalyticsOS℠ Cloud using a HTTPS request with a JSON payload.

1.1.1        HTTPS Request
Field Value
URL https://cloud.analyticsos.com/sensor-ingestion/api/v1/gps-data
Request Type POST
Autorization Bearer Token
1.1.2       HTTPS Request Parameters
Parameter Data Format Value Optional Default
user_id String ID of User requesting data
Yes Null


  • Some API clients will have access to data for multiple users and user_id must be provided. If an API client is for a single user, then user_id may be omitted.
1.1.3        HTTPS Request Body Structure
“topic”: “ASSET_1_GPS”,
“latitude”: 43.645074,
“longitude”: -115.993081,
“altitude”: 3307.09,
“altitude_units”: “ft”,
“timestamp”: 1577858400000,
“external_asset_id”: “123abc”
“topic”: “ASSET_2_GPS”,
“latitude”: 26.357896,
“longitude”: 127.783809,
“altitude”: 157.48,
“altitude_units”: “ft”,
“timestamp”: 1577858400000,
“external_asset_id”: “123abc”
}        Details

The gps_points JSON Array contains all the gps points AOS Cloud should process. The fields and their descriptions are outlined in the subsections below.

The gps topic declares an identifier for each source of data. GPS topic names are case sensitive. It is suggested that all topics names be uppercase and underscores used in the place of spaces.

Other naming conventions may be employed for GPS topics, such as using ID strings generated by the data source application or intermediate data handling layer. The GPS topic must also be known by the AOS model developers before the deployment of AOS.

This is to collect the assets north/south position, relative to the equator

This is to collect the assets east/west position, relative to the Prime Meridian

This is to collect the assets relative height to sea level (zero represents sea level)

This is to collect the unit of measurement for altitude, this is free form text (i.e. “ft”, “feet” are both fine)

The timestamp field contains the date and time of the occurrence being measured. In order to define a timestamp, use the clarifier timestamp followed by the data value as an integer i.e. 1473269535670 (which represents Wednesday, September 7, 2016 12:32:15.670 PM GMT-05:00 DST). Timestamp values should be specified in the Julian milliseconds since 1/1/1970 00:00:00 UTC standard.

External Asset ID
Customer identifier for the asset in question. This is how the AnalyticsOS℠ Cloud knows which sensor data to use when providing analytics for one asset vs another.

It is not necessary for topics to be published at a consistent time interval, even within one sensor topic. The AnalyticsOS℠ Cloud engine is capable of aggregating and analyzing asynchronous data.