What is Motion-S REST API?

Motion-S REST API serves as an interface to our platform that enables customers to submit their trips and get deep insights from their mobility data. The API documentation can be accessed here:

Obtain Credentials

Here you can register to our free trial and get more information how to start using our API:

The usage is subscription based, meaning each month you will be billed according to the number of active assets and type of plan you have chosen. We define an active asset as a device which was active in the billing period (1 month). Device becomes active when you submit a trip with it.

Our plans are divided into:

  • Data Augmentation plan
  • Mobility Profiling plan

For more information see data augmentation and mobility profiling.

Components of the API

Components of the API are divided into:

User, access and entity management

User management:

  • Organization
    • It represents your organization that can have multiple users which have access to the API. When we create an organization for you, you will be given the organization details, default fleet details as well as admin user credentials. With admin user credentials you can create additional users belonging to your organization which can then consume the API. You can also modify the details for your organization as well as get the consumption in terms of number of active assets(devices) and number of calls made towards our API grouped by months.
  • User
    • User can be admin and normal user. Normal user belongs to an organization and has its own credentials with which it can access API endpoints. Normal user is restricted in a way that it cannot create additional users because this functionalty is available only to the admin of the organization.

Access management:

  • Key
    • Key represents API key with which you can access API endpoints by setting it in the header or in the query parameters of the requests you send. Organization can have unlimited number of API keys and both admin and normal users can create them.
  • Session
    • Both admin and normal users can create a session which represents the action of logging into our system since as a response you will get access token as well as refresh token with which you can access API endpoints by setting access token in the headers or query parameters of the request being sent.

Entity management:

  • Fleet
    • Fleet represents a collection of devices. One organization can create multiple fleets. On start, you will get the default fleet created by us.
  • Device
    • Device represents the actual device which recorded the trip.
  • Driver
    • Driver represents a physical driver that is creating a trip. It is not mandatory to have one to submit the trip to our platform since we request the device to be present there.
  • Vehicle
    • Vehicle is representing the actual vehicle with its specification details.

Analytics on the trip data

Analytics part of our API is divided into several categories and depending on your plan you will be able to make requests towards those endpoints. Two major categories are:

  • Data Augmentation
  • Mobility Profiling

Data Augmentation Endpoints

You can get augmentation insights on the single trip level using the group of calls Trip Context and on the driver, device and fleet levels using the group of calls Analytics Context.

Mobility Profiling Endpoints

Mobility profiling is divided into four categories:

where each of those categories contain group of calls related to it. The analytics can be done the level of fleet, device, driver and a trip.