Skip to main content

Introduction

Feed items introduction

SEOPal runs tasks periodically to look for changes on the website that is being monitored and to notify appropriately.

Feed items will be available in the Feed Items endpoint for fetching all feed items for a website.

Each feed item is documented with what data is sent via the Webhook or what the data in the Feed Items endpoint will contain.

Each feed item document contains the following items, below is the definition of each title

Task

This is the feed item type, which you can use to differentiate the feed items. An example of a task is broken_links, or review_new

Frequency

The frequency is how often the task fires to check the website audit, if a task fires hourly, it will check if there are changes that need notifying about. Most of the time there won't be any changes so a webhook will not be triggered. Note: the frequency listed is the default SEOPal frequency, your frequencies may be different per Plan, ask your Customer Success Manager for a list of the frequencies for each plan.

Offset

The offset is the time after a website/competitor is added for this task to run for the first time. The point of this offset is to stop a website being added and being bombarded with notifications in the first few minutes. This delay is designed to spread the initial notifications out over a longer period of time.

Status

Each feed item will have only one status, the status is designed to give you a way to show different templates to the user based on good or bad notifications. there are currently 4 statuses: success, warning, error, info

success - this is a positive notification, that something has been fixed, or the website does something well.

warning - this is a moderate warning notification, that something should be fixed, but may have a low impact to SEO.

error - this is a negative notification, that something should be fixed, and has a high impact on the websites SEO.

info - this is a notification for information, where it cannot have a positive or negative outcome, for example the weekly summary contains both positive and negative feedback and therefore is an info status.