Jump to Content
Home
Guides
API Reference
Home
Guides
API Reference
v3.0
Home
Guides
API Reference
Status Page
Help Centre
Perspio Portal
API Reference
Status Page
Help Centre
Perspio Portal
v3.0
Home
Guides
API Reference
Create Dashboard
Search
JUMP TO
Getting Started
Perspio Developer Hub
Quickstart
Postman Collection
OpenAPI Spec
SDK (API Clients)
Authentication
Create Application
Create User
Get Access Token - Client Credentials
Get Access Token - Authorization Code
Use Access Token
Refresh Access Token
REST API Overview
Base URL
Request Methods
Response Codes
Rate Limiting & Quotas
Roles and Security Groups
Date and Time Format
IP Addresses & Whitelisting
Object IDs
Assets
Create Asset
post
Get Assets
get
Get Asset
get
Update Asset
patch
Delete Asset
delete
Telemetry
Get Asset Events
get
Get Asset Metrics
get
Update Asset Meters
patch
Get Asset History
get
Get Object History
get
Get Custom Counters
get
Update Custom Counters
patch
Get Metrics Summary
get
Get Asset Anomalies
get
Get Asset Forecast
get
Negotiate Socket Connection
post
Get Recent Events
get
Get Asset Trips
get
Get Recent Trips
get
Get Fuel Utilisation
get
Gets Meters Utilisation
get
Get Utilisation Average
get
Get Events Master Data
get
Bulk Update Events Master Data
post
Get Trips
get
Get Metrics Count
get
Get Latency Data
get
Update Events Master Data
patch
Get Utilisation Summary
get
Asset Details
Submit Assets Import Task
post
Submit Asset UpdateTask
post
Get Asset Info
get
Update Asset Info
patch
Get Asset Relationships
get
Get Asset Schema
get
Get Asset Master Schema
get
Update Asset Master Schema
patch
Share an Asset
post
Get Asset Schema
get
Get Rental History
get
Get Servicing History
get
Get Asset Groups
get
Update Asset Groups
put
Get Asset Types
get
Get Asset Type
get
Get Asset Cameras
get
Get Asset Snapshot
get
Share Asset
post
Get Share Tokens
get
Update Share Token
put
Get Assets Info
get
Get Tenant Hierarchies
get
Get Asset Schema 2
get
Get Asset Schema 2
get
Get Asset Workflow History
get
Get Asset Types 2
get
Get Asset Type 2
get
Get Object Dependencies
get
Documents, Links & Images
Upload Asset Image
post
Get Asset Images
get
Delete Images
delete
Delete Asset Document
delete
Get Asset Documents
get
Update Asset Document Metadata
put
Upload Asset Document
post
Get All Document Links
get
Upload Document Link
post
Delete Document Links
delete
Update Document Link
put
Update Image Metadata
put
Add Asset Comment
post
Get Asset Comments
get
Asset Profiles
Get Working Hours Profile
get
Update Working Hours Profile
patch
Upsert Share Config
post
Upsert Share Config
put
Get All Share Configs
get
Delete Share Config
delete
Get Share Config
get
Get Assets Share Config
get
Servicing
Get Servicing
get
Get Service Entries
get
Get Service Programs
get
Get Service Reminders
get
Apps
Create App
post
Get Apps
get
Get App
get
Delete App
delete
App Management
Get App Subscription Key
get
Get App Users
get
Reset App Secret
post
Connectors
Get Ingress Connectors
get
Get Action Connectors
get
Get Data Connectors
get
Get Webhooks Connector
get
Update Connector Configuration
post
Enable Connector
post
Disable Connector
post
History
Get Configuration Value
get
Get Action Schema Template
get
Get Action Schema
get
Get Action Quotas
get
Get Ingress Connector History
get
Get Action Connector History
get
Get Data Connector History
get
Get Webhook Connector History
get
Events
Negotiate Socket Connection
post
Get Connector Events
get
Checkpoints
Get Ingress Connector Checkpoints
get
Get Data Connector Checkpoints
get
Safety Culture
Get Safety Culture Groups
get
Get Safety Culture Users
get
Get Safety Culture Assets
get
Dashboards
Create Dashboard
post
Get Dashboards
get
Get Dashboard
get
Get Dashboard Dictionaries
get
Get Dashboard Assets
get
Get Dashboard Data
get
Update Dashboard
put
Delete Dashboard
delete
Widgets
Get Dashboard Widget
get
Get Dashboard Widget Data
get
Images
Upload Dashboard Image
post
Delete images from a specific Perspio dashboard by ID.
delete
Get Dashboard Images
get
Devices
Get All Device Types
get
Get Device Types
get
Get All Device Types 2
get
Get Device Types 2
get
Trips
Get Device Trips
get
GetRecentTrips
get
Get Device Trips Count
get
Events
Get Recent Device Events
get
Get Device Events
get
Get Device Events Count
get
Management
Get Access Pin
get
Immobilise
post
Telemetry
Get Device Snapshot
get
Update Device
patch
Get Device History
get
Get Device Metrics
get
Get Devices Current State
get
Get Device Telemetry Count
get
Get Device Metrics ADX
get
Update Odometer
post
Update HourMeter
post
Get Device Message Frequency
get
Get Device Metrics Count
get
Get Device Latency Data
get
Schema
Get Device Schema
get
Get Device Schema By Type
get
Get Device Schema 2
get
Get Device Schema 2
get
Metadata
Get Device Metadata
get
Get Device Info
get
Get Devices Catalog
get
Geofences
Create Geofence
post
Get Geofences
get
Get Geofence
get
Get Geofence Asset Groups
get
Get Geofence Assets
get
Get all Region Geofences
get
Get all Weather Alert Geofences
get
Update Geofence
put
Update Geofence Asset Group
patch
Delete Geofence
delete
Geofence
GeoJson Geofence
Toll
Get Toll Geofence
get
Get Toll Geofences
get
Events
Get Geofence Events
get
Get Toll Geofence Events
get
Groups
Create Asset Group
post
Copy Asset Group
post
Get Asset Groups
get
Get Asset Group
get
Update Asset Group
put
Delete Asset Group
delete
Membership
Get Group Members
get
Update Group Members
put
Get Asset Group Membership Changes
get
Organisation
Get Invoices
get
Get Tenant Inventory
get
Get System Jobs
get
Get Tenant Actions Consumption
get
Get Tenant Consumption
get
Banners
Get Notifications
get
Get Notification
get
Config
Get Tenant Config
get
Update Tenant Config
patch
Info
Get Tenant Info
get
Update Tenant Info
patch
Logo
Upload Tenant Logo
post
Delete Logo Images
delete
GetLogoImage
get
GetLogoImages
get
People
Get All Drivers
get
Get Driver
get
Profiles
Custom Counters
Create Custom Counter
post
Get All Custom Counters
get
Delete Custom Counter
delete
Get Custom Counter
get
Update Custom Counter
put
Working Hours
Create Working Hours Profile
post
Get Working Hours Profiles
get
Delete Working Hours Profile
delete
Update Working Hours Profile
put
Get Working Hours Profile
get
Share Details
Update Details Sharing Profile
put
Delete Details Sharing Profile
delete
Get Details Sharing Profile
get
Get Details Sharing Profiles
get
Create Details Sharing Profile
post
Public
Get Shared Assets
get
Reports
Create Report
post
Submit Get Report Data Task
post
Get Report Schema
get
Get Report History
get
Get Report Dictionaries
get
Get Reports
get
Get Report Data
get
Get Report
get
Update Report
put
Delete Report
delete
Scheduled Reports
Create Report Schedule
post
Get Report Schedules
get
Delete Report Schedule
delete
Get Report Schedule
get
Update Report Schedule
put
Get Tenant Scheduled Reports
get
Saved Reports
Get Saved Reports
get
Get Saved Report File
get
Search
Save Search
post
Get Assets In Proximity
get
Get Object Dependency
get
Global Search
get
Get Saved Searches
get
Delete Saved Search
delete
Servicing
Schedules
Get All Service Schedules
get
Create Service Schedule
post
Update Service Schedule
patch
Delete Service Schedule
delete
Programs
Get All Service Programs
get
Create Service Program
post
Get Service Program
get
Update Service Program
patch
Delete Service Program
delete
Get Assets For Service Program
get
Update Service Program Assets
put
Update Service Program Schedules
put
Reminders
Get Service Reminders
get
Get Service Reminder
get
Entries
Get Service Entries
get
Create Service Entry
post
Delete Service Entry
delete
Get Service Entry
get
Update Linked Reminders For Service Entry
put
Tasks
Create Task
post
Get Tasks
get
Get Task
get
Users
Create User
post
Create User Log
post
Get Users
get
Get User Logs
get
Get Data Access For User
get
Get Group Users
get
Get User Access
get
Get User Access Profiles
get
Get User Access Profile
get
Get Users Extensions
get
Get Users Preferences
get
Get User Preferences
get
Update User
patch
Update User Preferences
patch
Update Data Access For User
post
Submit Create User Task
post
Update User Access
post
Delete User
delete
Current User
Get Current User Logs
get
Get Current User
get
Update Current User
patch
Update Current User Extension
patch
Add Current User Extension
post
Get Current User's Extensions
get
Get Current User Access
get
Workflows
Get Workflows
get
Get Workflow
get
Get Workflow Checkpoints
get
Update Workflow
post
Copy Workflow
post
Unsuppress Checkpoint
post
Unsuppress checkpoint
post
Delete Workflow
delete
Workflow Helpers
Get Data Schema From Rule Scope
post
Get Event Types
get
Get Assets
get
Get Workflow Scope Assets
post
Get Groups
get
Get Workflow Trigger History
get
Get Workflow History Metrics Count
get
Get Data Schema From Rule Scope 2
post
Get Metadata
get
WorkOrders
Service Jobs
Get Service Jobs
get
Get Service Job
get
Transport Dockets
Get Transport Dockets
get
Transport Docket Lines
Get Transport Docket Lines
get
Powered by
Create Dashboard
post
https://talk.perspio.io/dashboards/v3/
Create a Perspio dashboard
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
RESPONSE
Click
Try It!
to start a request and see the response here!