How to read the URL checker links report

The URL checker links report includes 13 columns.

You can work through this report in any number of ways. For example, you can:

  1. Open the CSV in Excel or a similar program.
  2. Filter by the Status column to focus on Pass or Fail links.
  3. Filter by the Object Type column.
  4. Work through each Object Type in more detail to audit and update links.

Refer to Links report best practices for some general guidance on making sense of this report. Refer to Tips & tricks for using the links report for more suggestions on finding and resolving individual broken links. 

Object ID

The Object ID column displays the ID of the object for individual objects like articles, snippets, and categories.

This column is left blank for knowledge base-wide things like Theme or Homepage.

Object Type

The Object Type column displays which type of object the broken link is found in. The available types are:

  • Article
  • Article Version (only included if you choose to include article versions in the content of the report. Refer to Additional content options)
  • Category
  • Homepage (For any links included in Customize > Homepage)
  • Snippet
  • Theme (For any links included anywhere in Customize > Style (HTML & CSS))

App Edit Link

The App Edit Link column displays the app.knowledgeowl.com editor link to the page that contains the broken link. Use this field to open the object for editing so you can resolve the issue.

For theme links, this is just the URL to Customize > Style (HTML & CSS).

View Link

The View Link column displays a link to the live knowledge base page that contains the broken link. Use this field to view the page and try to open the link to see what happens.

Some objects (such as snippets, theme, etc.) do not have a live View Link.

Object Field

The Object Field column displays which field on the object contains the link.

The list of available fields depends on the Object Type. For Theme, this field includes which portion of the Custom HTML the link's located within.

Refer to Which content is checked for more detail on which object fields are checked.

Link URL

The Link URL column displays the URL that's considered broken.

Link Text

For URLs included in body or HTML content, the Link Text column displays the text associated with that link.

This can help you identify where in the body you need to update the link.

The column displays N/A for object fields where you just assign the URL directly, such as URL redirects, icons, banners, and thumbnails.

HTML Tag

The HTML Tag column indicates what HTML tag the link is located within. This can help you more quickly find the link or content that needs updating if this was a failed link.

Common options include:

  • a: For regular hyperlinks, where we check the href attribute of the hyperlink.
  • iframe: For iframes inserted into your content, we check the src attribute.
  • img: For images inserted into your content, we check the src attribute.
  • video: For videos inserted into your content, we check the src attribute.
  • N/A: We use this HTML Tag when the link isn't found within HTML on the page. This is most common for cases where the URL is stored directly within KnowledgeOwl, including:
    • URL redirect articles and categories
    • Article thumbnails and banners
    • Category icons

Link Type

The Link Type column identifies whether the link points to another page within KnowledgeOwl or to a page outside of KnowledgeOwl. It always contains one of two values:

  • Internal for links that refer to resources within KnowledgeOwl (files, other articles, etc.)
  • External for links that refer to websites and resources outside of KnowledgeOwl

Status Code

The Status Code column displays the HTTP status code we received when we checked the link.

Refer to Common HTTP status codes for a description of some common status codes.

Author

For objects that have an author (such as articles or some category types), the Author column displays the name of the current designated author.

The column displays N/A if this information is not tracked, such as for theme.

The column displays a blank if the author has been deleted since they saved a change.

Last Modified Author

For objects where we track the date and author when modifications are made, the Last Modified Author column displays the name of the author who last saved changes to the object.

The column displays N/A if this information is not tracked, such as for theme.

The column displays a blank if the author has been deleted since they saved a change.

Status

The Status column provides a quick, filterable status for each link. It always contains one of two values:

  • Pass: Links with a Pass status have HTTP status codes that indicate a page does generally load. This status includes 200-level and most 300-level codes. These are generally safe to ignore since pages do ultimately load, so your reader experience won't be compromised by ignoring them.
  • Fail: Links with a Fail status have HTTP status codes that indicate a problem loading the page. This status includes all 400-level and 500-level codes.

If you're doing an audit to identify broken links, you can generally begin by filtering this column to Fail statuses only.