Routes
In the world of Pulsetic's API, "Routes" are like specific addresses you use to ask for information or make changes. They're the URLs (web addresses) that tell Pulsetic exactly what data you want or what actions you want to take. While they don't control the flow of internet traffic, they are the keys to accessing and using Pulsetic's powerful monitoring tools.
Why Routes Matter
Pulsetic's API is organized around a set of defined routes, each designed for a specific purpose. These routes are your tools for everything from getting detailed reports on your website's performance to managing your public status pages. Understanding these routes will make your interaction with Pulsetic's API efficient and effective.
Route Categories and Basic Functions
Monitor Data Retrieval
These routes are for getting information about your monitors, like how they've performed over time or the results of individual checks.
Examples:
- Getting snapshots of monitor performance over time.
- Getting detailed results from Pulsetic's monitoring locations.
- Track when your monitors went online or offline.
Monitor Management
These routes allow you to control your monitor settings, like adding new monitors or changing existing ones.
Examples:
- Listing all your monitors or creating new ones.
- Updating or deleting monitors.
- Getting the downtime of a monitor.
Status Page Management
These routes help you manage your public status pages, which you use to keep your users informed about service availability.
Examples:
- Create, read, update, or delete status pages.
- Scheduling maintenance windows.
- Reporting and managing incidents.
- Managing incident updates.
Imagine you want your website's uptime data to show up automatically on your company's dashboard. Use the Monitor Data Retrieval routes to pull that data without doing it by hand. This keeps your dashboard updated. When your site has problems, use the Status Page Management routes to quickly update your status page. These routes let you automate tasks and make your work easier.