Skip to main content

Getting Started

Before starting to integrate with the API. Please read this document, the aim is to provide some context on the general flow of how to start monitoring websites.

Please familiarise yourself with the how to authenticate with the API - Authentication

Setting up a website to monitor​

  1. Create a user - Users
  2. Create a Business - Businesses
  3. Create a BusinessLocation for the Business - Business Locations
  4. Create a Website for the Business - Websites
  5. OPTIONAL - Create a Competitor for the Website (max 3) - Competitors

Note: Once you complete step 5 from above, SEOPal will add the tasks to start monitoring the website and if you have configured a Webhook then you will start receiving notifications for that Website

Note: As soon as you add a Competitor SEOPal will add the tasks to start monitoring the competitor.