REST API Overview

Conventions shared by every PerspioTalk API.

PerspioTalk is a set of REST APIs over HTTPS, one for each area of Perspio: Assets, Devices, Reports and so on. Each API has its own version, and they all share the conventions on this page and the pages under it.

TopicIn shortDetails
Base URLshttps://talk.perspio.io (AU) and https://us-talk.perspio.io (US)Base URL
AuthenticationA bearer token, your tenant ID (tid) and subscription key on every callAuthentication
RequestsJSON bodies. PATCH takes a JSON Patch documentRequest Methods
ResponsesStandard HTTP status codes, with JSON error bodiesResponse Codes
Pagingpage_size and a ContinuationToken headerPagination
LimitsA rate limit per application and a quota per tenantRate Limiting & Quotas
AccessAccess profiles control which operations, security groups control which assetsRoles and Security Groups
Dates and timesISO 8601 in UTCDate and Time Format
NetworkingHTTPS on port 443, allow by hostnameIP Addresses & Whitelisting
Object IDsReadable IDs with a tenant prefix, such as in-000123Object IDs
📘

TLS 1.2 or later

PerspioTalk only accepts HTTPS connections using TLS 1.2 or 1.3. Make sure your HTTP client supports TLS 1.2 as a minimum.