Welcome to the Pay as you Track API. If you don’t find what you are looking for, please get in touch! Every business is different and we always do our best to make our API work for you. Getting Started How does the API work? Overview | Data Concepts | Authentication Data Concepts How is Pay as you Track data structured? Data Concepts | Events | Json Dates Groups Working with Pay as you Track folders Groups Vehicles How to […]

This section provides an overview of how data flows to and from the Pay as you Track API. As the API is JSON based, make sure you’re familiar with http and JSON. Typically, a client will authenticate, make one or more calls to the API and then logoff. Logging off is not strictly necessary (but is recommended) as the ticket that is allocated during the authentication process will timeout if not used. All calls to the Pay as you Track […]

This section details a number of reports that are available as standard. This gives a flavour of the data that is available via the API. The system has significantly more reports than those detailed here. We also provide bespoke data extraction calls if you need access to business specific device data. Calls in this section (apart from historic) return data in an unnormalised form. Each call has a specific return dataset, this is detailed in each section. Calls in this […]

After successful authentication with the Pay as you Track API data is returned from the API in a format that is based on (but does not fully follow) the Google Visualization JSON format. This is described here: https://developers.google.com/chart/interactive/docs/dev/implementing_data_source#json-response-format A typical successful call to the Pay as you Track API will result in a status of “ok” and a “dataset” field. This is where the payload of the Pay as you Track API deviates a little from a Google DataSource. A […]

This section provides an overview of how to authenticate with the Pay as you Track API. Calls in this section: Login Logout Logging on Necessary before any subsequent call to the API. Look for a return of “ok” and a GUID in the “ticketid”. Any previously allocated tickets for these login credentials will expired. This means you cannot use the same authentication details more than once. Request (Query Parameters) Parameter Value Notes op Authenticate Required subop Login Required clientname {LEAVE […]

All major entities in the Pay as you Track system are contained within groups. They are referred to as ‘Folders’ in the front end. There are 3 main types: Vehicles (type 3), Locations (type 5), Users (type 2), Drivers (type 4). Calls in this section GetByTypeID GetByTypeID Retrieve all groups for a given type. Look for a return of “ok” in the status field. Note that every folder belongs to one and only one parent group. Request (Query Parameters) Parameter […]

Vehicle information is generally returned in a VehicleDetailsDataSet Asset table. To reduce the number of server calls this is an unnormalised view of the current state of the vehicle. It includes information such as the currently assigned driver and tracker as well as some standard vehicle fields. For calls that result in positions, data is returned in a VehiclePositionDataSet. Note that the unique VehicleId field is important as a number of other calls in the system require this as a […]

Positional data stored in the Pay as you Track system is marked with an event code – think of this as a reason the record exists. Most events in the system fall into the category of start, stop and moving but there is a much larger list of events. Not all trackers can generate all types of events. Here are some of the most useful. You might encounter an event that doesn’t appear here. If you are unsure, just ask! […]