Introduction

If Sopht is unable to retrieve usage metrics with one of the existing collectors, you can send the digital workplace metrics to us directly using our Json API.

Actions Summary

1. Request your Backbone API key from Sopht in advance to authenticate
2. Follow the Backbone API Swagger documentation to send Microsoft 365 usage metrics in the required format:
   • The relevant endpoint is: POST/metrics/workplace
   • The detailed API documentation can be found here : Swagger documentation

Actions Guide

1. Request and retrieve your Backbone API key

2. Follow the Backbone API Swagger documentation

Details of API behavior

Always send all the data for a single day from the same origin (Microsoft 365 or Google Workspace) and source in the same API call : the API doesn’t support updating only partial data for a single day, so all the already uploaded data for a day will be overriden by a new upload.

Only the last upload per origin and per source will be integrated, so make sure to send all the relevant data for the same origin and source in a single daily API call.

The data sent via the API is considered a different source as the data coming from the collectors, meaning that metrics coming from the API and a collector will be summed, regardless of the source parameter that might have been specified.