Create location history

curl --request POST \
  --url https://apiweb.mile.app/api/v3/location-history \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "lat": "<string>",
  "lon": "<string>"
}
'

{
  "status": true,
  "message": "Success",
  "location_history": {
    "email": "example@mile.app",
    "taskId": "634e98098ce69d29474a7e11",
    "speed": 40,
    "distance": 50,
    "duration": 50,
    "lat": -6.1771046,
    "lon": 106.9240199,
    "_id": "634e98098ce07d29474a7e22_example@mile.app_1675224349343",
    "time": 1675224349343,
    "organizationId": "634e98098ce07d29474a7e22",
    "createdTime": "2022-10-07 03:00:58",
    "updatedTime": "2022-10-07 04:00:58"
  }
}

Location History

Create location history

Location history has three types of payloads:

General: This payload is sent without any specific business process. All payloads sent will be saved and can be visualized.

Start - Finish: This payload tracks a user’s movement, both during general online activity and while performing a specific task. The ‘Finish’ payload cannot be saved unless it is preceded by a ‘Start’ payload, and a new ‘Start’ payload cannot be saved until the previous one has been completed.

Custom Data: This payload is typically used by integrators. MileApp provides a ‘data’ key with an object data type. This key can store dynamic data according to user needs. For example, users can store data such as fuel levels, vehicle temperature, and more.

** Related Guide Introduction to Tracking **

POST

location-history

Create location history

curl --request POST \
  --url https://apiweb.mile.app/api/v3/location-history \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "lat": "<string>",
  "lon": "<string>"
}
'

{
  "status": true,
  "message": "Success",
  "location_history": {
    "email": "example@mile.app",
    "taskId": "634e98098ce69d29474a7e11",
    "speed": 40,
    "distance": 50,
    "duration": 50,
    "lat": -6.1771046,
    "lon": 106.9240199,
    "_id": "634e98098ce07d29474a7e22_example@mile.app_1675224349343",
    "time": 1675224349343,
    "organizationId": "634e98098ce07d29474a7e22",
    "createdTime": "2022-10-07 03:00:58",
    "updatedTime": "2022-10-07 04:00:58"
  }
}

Authorizations

Authorization

string

header

required

Use a valid Bearer token to authenticate.

Body

application/json

string

Required, User's email assigned to the monitored task. Example: example@mile.app

lat

string

Required, Latitude coordinate position or location of any place on Earth's surface. Example: -6.1771046

lon

string

Required, Longitude coordinate position or location of any place on Earth's surface. Example: 106.9240199

Response

Success

status

boolean

Indicates whether the request was successful.

code

integer

HTTP status code.

message

string

A message providing additional information about the response.

location_history

object

Show child attributes

location_history.email

string

User's email assigned to the monitored task.

location_history.lat

number

Latitude coordinate position.

location_history.lon

number

Longitude coordinate position.

location_history.speed

integer

Vehicle speed in kilometers per hour.

location_history.distance

integer

Distance traveled from the previous location.

location_history.distanceToDest

number

Distance estimated from the next location.

location_history.duration

integer

Time duration spent at this location in milliseconds.

location_history.createdTime

string

Time at which the location history was created.

location_history._id

string

Unique identifier for the location history entry.

location_history.taskId

string

Unique ID to identify the task.

location_history.time

integer

A timestamp indicating the time of the location history entry.

location_history.organizationId

string

Unique identifier for the organization.

location_history.eventName

string

A flagging of location history with value otw, nearBy and done.

location_history.isLatest

boolean

Identifier for flagging the latest location history

location_history.createdFrom

string

A flagging for describe location history created from, default value generated by system is mileAppField.

location_history.updatedBy

string

Email of the user who last updated the location history entry.

location_history.createdBy

string

Email of the user who created the location history entry.

location_history.updatedTime

string

Time at which the location history entry was last updated.

Read location history by token Bulk create location history

⌘I

Getting Started

Webhook

Task

Routing

Flow

Data

Setting

Import/Export

File

Objects

Create location history

Authorizations

Body

Response