get
https://app1.compliancely.com/api/v1/monitoring/sos//version//snapshot/
Overview
Use this endpoint to retrieve the complete SOS object represented by a specific monitoring version.
While Version Detail focuses on differences from the previous version, Snapshot provides the full SOS data associated with the selected version.
When Should I Use This API?
Use Snapshot when you need to:
- Retrieve the complete SOS record at a particular version.
- Display the full historical SOS information.
- Reconstruct the state of the SOS record at a particular point in its monitoring history.
- Compare complete SOS objects in your own application.
Example
Version 1 Snapshot
↓
Complete SOS Object at Version 1
Version 2 Snapshot
↓
Complete SOS Object at Version 2If Version 2 contains an address change, the Version Detail endpoint can tell you what changed, while the Version 2 Snapshot gives you the entire SOS object after that change.
Version Detail vs. Snapshot
| Endpoint | Returns | Use When |
|---|---|---|
| Version Detail | Differences from the previous version | You need to know what changed |
| Version Snapshot | Complete SOS object for the version | You need the full SOS state |
Related APIs
- List SOS Versions — identify available versions.
- Version Detail — retrieve differences for the selected version.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
