The ObservePoint API is powerful, and has many endpoints. Knowing which endpoints to use is key. This doc will help you choose.
There are 3 types of actions you can perform with the API:
All of the data which ObservePoint collects about your websites is available via the API.
There are two ways to get results data from ObservePoint:
- The Grid Reporting API recommended
- The Grid Reporting API is the fastest and most flexibe way to get ObservePoint results data.
- To get started, see the Grid Reporting API Docs or Grid Reporting API Examples
- Audit and Journey APIs:
- These legacy APIs allow you to get results data from a single run, a single audited page, or a single journey action at a time.
- See v3 API Reference for the full API documentation.
- See API recipes for examples
You can configure anything in ObservePoint via the API. This includes audits and journeys, and a lot more.
Examples:
- Creating and updating audit configurations
- Creating and updating journeys, and their actions
- Creating users
- Creating folders
- Creating and updating standards like consent categories and tag & variable rules
- ... and much more
Most users schedule audits and journeys within ObservePoint, so they don't need to use the API to run them. However, if you have specific events that should trigger an audit or journey to run, you can use the API to run them.
Examples: