Skip to content
Analytics/
Retrieve SLA analytics da...

M2X APIS (1.0.0)

M2X APIs

Download OpenAPI description
openapi.json
openapi.yaml
Overview
License
All Rights Reserved
Languages
Servers
Mock server
https://developer.m2x.app/_mock/apis/publicapi/openapi/
https://developer.m2x.app/apis/v0/
NZ Production server (uses live data)
https://m2x.app/apis/v0/
US Production server (uses live data)
https://us.m2x.app/apis/v0/
AUS Production server (uses live data)
https://au.m2x.app/apis/v0/
Sandbox server
https://staging.m2x.app/apis/v0/

Analytics

Analytics data

Operations

Retrieve SLA analytics data

Request

Security
M2X_auth_application
Bodyapplication/jsonrequired

Query criteria for SLA data

startstring(date-time)required

RFC3339 start of the window

Example: "2021-01-01T12:00:00.000Z"
endstring(date-time)required

RFC3339 end of the window

Example: "2021-06-30T11:59:59.999Z"
fromTypestring

From type

Enum"region""district""location""locationGroup"
Example: "locationGroup"
endTypestring

End type

Enum"region""district""location""locationGroup"
Example: "locationGroup"
fromIdstring or null

Id of the pickup grouping entity,

Default null
endIdstring or null

Id of the delivery grouping entity

Default null
groupsArray of objects(SLARequestGroup)

Grouping entities

Default []
productCodeIdsArray of strings

Product code ids

Default []
productTypesArray of strings

Product types

Default []
Example: ["Livestock"]
typestring

Type of delay analysis, eg. daily, hourly

Default "daily"
Enum"daily""hourly"
curl -i -X POST \
  https://developer.m2x.app/_mock/apis/publicapi/openapi/analytics/sla \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "start": "2021-01-01T12:00:00.000Z",
    "end": "2021-06-30T11:59:59.999Z",
    "fromType": "locationGroup",
    "endType": "locationGroup",
    "fromId": null,
    "endId": null,
    "groups": [],
    "productCodeIds": [],
    "productTypes": [],
    "type": "daily"
  }'

Responses

The requested SLA(DIFOT) analytics data

Bodyapplication/json
statusobject(SLAStatus)
slaOverTimeArray of objects
slaDelaySplitsArray of HourlyDelaySplits (object) or DailyDelaySplits (object)(SLADelay)
Response
application/json
{
  "status": {
    "breached": { … },
    "none": { … },
    "respected": { … },
    "totalJobs": 0,
    "totalQuantity": 0,
    "totalWeightKg": 0
  },
  "slaOverTime": [
    { … }
  ],
  "slaDelaySplits": [
    { … }
  ]
}

Billing Groups

Invoiceable unit used by the system

Operations

Bookings

Bookings information

Operations

Carrier Bookings

Corporate bookings received by carriers

Operations

Carrier Large Contracts

Carrier large contracts

Operations

Carrier Orders

Carrier orders

Operations

Corporate Planning

Corporate Planning supplies and demands

Operations

Customer Bookings

Customer bookings on carriers

Operations

Customers

Customers used for invoices

Operations

Drivers

Drivers information

Operations

Fuel

Fuel deliveries management

Operations

Fulfilment Requests

Fulfilment request on carriers

OperationsWebhooks

General Consignments

General consignments

Operations

ISO containers

ISO containers information

Operations

Jobs

Vehicle units of work

OperationsWebhooks

Locations

Locations information

Operations

Master Bookings

Master bookings

OperationsWebhooks

Offers

Corporate monetary offers to carriers

OperationsWebhooks

Products

Products used by the system

Operations

Runs

Runs management

Operations

Subcontractors

Subcontractors information

Operations

Tractor Unit

Tractor units information

Operations

Trailer

Trailers information

Operations

Transaction

Transaction management

Operations

Vehicle

Vehicles information

Operations

Vehicle Execution Statements

Unit of execution for trucks

OperationsWebhooks

Consignments

Webhooks