Overview
Use this endpoint to retrieve the versions available for a specific SOS monitoring request.
Versions represent the historical SOS data maintained by Compliancely as the entity is monitored over time.
When Should I Use This API?
Use this endpoint when you want to:
- View the available SOS versions for a monitored entity.
- Identify a version before retrieving its details.
- Navigate the SOS data history.
- Determine which version should be used to retrieve a snapshot.
Versions vs. Monitoring Attempts
Monitoring attempts and versions represent different concepts.
Timeline represents monitoring executions.
Versions represent the SOS data history available for the monitored entity.
A monitoring attempt therefore should not automatically be interpreted as a change to the SOS record.
What Do I Do With a Version?
After identifying the required version, you can use:
Version Detail
Retrieve the differences associated with that version compared with the previous version.
Version Snapshot
Retrieve the complete SOS object represented by that version.
List Versions
↓
Select Version
↓
┌───────────────┬────────────────┐
↓ ↓
Version Detail Version Snapshot
What changed? Full SOS objectRelated APIs
- Monitoring Timeline — monitoring attempt history.
- Version Detail — changes for a selected version.
- Version Snapshot — complete SOS data for a selected version.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
