Annotations Overview
Once added, an Annotation will display on any relevant chart across the platform when a date range is selected that includes the date(s) of the Annotation. Annotations appear on charts as icons above the date axis of a chart. Clicking the icon will open the list of Annotations falling within the selected date range.
Background & Requirements for Annotations
Annotations are available to all seoClarity users of any package. No special setup is required. Annotations are to be differentiated from
Events. For the most part, Events are changes in your platform that are recorded automatically, although they can be added manually. Events do not show up in time-related charts and also have fewer options than Annotations. In most cases you will probably want to use Annotations rather than Events for recording time-stamped events, actions, or observations. Annotations can be created from and appear on charts in any of these features:
- Rank Intelligence
- Site Clarity
- Search Analytics
- Page Clarity Detail
- Keyword Detail
Annotation Use
Cases
Think about any activity within or outside your control that
may impact your SEO results– activities and actions undertaken by yourself,
your team or others in the organization, observations, events and notes that
you may want to record and correlate to your performance that were not
automatically captured. Here are just a few ideas on how you can use as annotations:
-
Global Annotations
- Dates when algorithm updates occurred
- Site UI or architecture changes
- Major changes in PPC investments that may
cannibalize SEO
- Anomalies in data due to external events (COVID)
or data errors (like Analytics issues)
-
Page tag / Keyword tag level annotations
- To record start and completion of tests
- Track changes that impact a group of pages or
keywords. For example, template changes
- Track dates of URL migrations
-
Keyword or Tag level annotations
- Specific page level changes
- Keyword level observations of key dates
Annotation Features
Watch this video for an overview of Annotations and how to create them:
Annotations Basics
- Annotations can be added at a global, page tag, keyword tag, page detail or keyword detail level.
- Annotations can be associated with pre-set Groups or new Groups created by the user.
- Annotation icons in charts are color-coded by Groups, and the user can select a color for custom-created Groups.
- Annotations can be either included or excluded in dashboards, reports, and PDFs.
- Annotations will only display on charts relevant to their associated Elements and Groups
Annotations in Charts
Annotations appear in charts as color-coded icons above the date axis, above the date with which they are associated. The icon displays the number of Annotations recorded for the date to which it points.
Viewing Annotations
To view any Annotations associated with the date range and elements shown on a chart, either
- Click on an Annotation icon above the date axis of the chart, OR
- Click on the Annotations tab beneath the chart.
Note that clicking on an icon will only display Annotations associated with that icon's date and group. To see all Annotations in the date range of a chart, use the second option above.
Annotations Listing Box
Any Annotations that meet the criteria of the chart will display in a box beneath the chart after using one of the methods above for viewing Annotations.
Annotation Filters
- Date range selector: By default, the Annotations list box shows the date range of the chart with which it is associated. User may select a different range. This does not affect the date range of the chart or any other results shown on the page.
- Group selector: Select from pre-set Annotation Groups or any user created Groups. Click Update to filter the Annotations list by the selection.
Annotation columns
- Date: The date associated with the Annotation
- Title: The title of the Annotation. Also will display the Description if any was created.
- Element: The Element (keyword, page, keyword tag, or page tag) associated with the Annotation, if any was specificed.
- Group: The Group to which the Annotation was assigned (if any)
Annotation inputs
- Add New: Opens a popover box allowing creation of a new Annotation
- Pencil icon: Opens the Annotation in a popover box allowing edits.
- Trash can icon: Deletes the Annotation. It will no longer appear anywhere in the platform.
Add Annotation Box
The Add Annotation Box is also used for editing existing Annotations.
Date: Set the date or date range with which the Annotation should be associated.
Title: The name of the Annotation
Description: A more detailed description of the Annotation (optional)
Group: Select a pre-set or user-created Group with which to associate the Annotation. Use the pencil icon to create new Groups.
Associated Element: Associate the Annotation with a variety of platform elements.
Submit: Create the Annotation.
How To Delete Annotations
Annotations can be removed via the Annotations page found in the top navigation on the Actions menu. Annotations can be also be removed when being viewed in their corresponding platform feature.