Skip to main content

HTML en JSON Reports

HTML Report

The HTML Report is a quick way to get an overview of the state of the links on your site. Without the need to login into the administrator.

It has basically the same information as the email-reports. The HTML report will always show all links and not since the last invocation, like the email-report does (depending on settings).

The contents of the report can be tweaked using query parameters:

  • broken=1 - report broken links
  • warning=1 - report links with a warning, for example timeouts
  • redirect=1 - report links with a redirect
  • parked=1 - report links that redirect to a domain parking service
  • new=0 - report the latest links
  • limit=50 - show this limit of links (per 'type')
  • source=0 - Include all items (articles, categories etc.) where the link was found. Including the anchor and links to view and edit the item.

The HTML report only includes unmarked links. So links that are marked as working ,hidden or to be ignored are never included.

The same options can be used for the email report, although it's intended that this report is configured from the components settings.

Example link (default settings + sources)

https://example.com/component/ajax/?plugin=blcReport&format=html&token=<your-token>&tmpl=component&source=1

JSON Report

This format sends the requested links as a JSON encoded string. The information is in the →data property.

The following parameters can be used to refine the selection:

  • broken=1 - include broken links
  • warning=1 - include links with a warning 
  • parked=1 - include links that redirect to a domain parking service
  • redirect=1 - include links that redirect
  • all=0 - ingore settings above and show all links
  • internal=0 - include only internal links
  • external=0 - include only external links
  • checked=1 - include only checked links
  • working=0 -  Possible values:
    • 0 - only unmarked links 
    • 1 - only links marked as working (ignore forever)
    • 2 - only links marked to ignore (ignore until status changes)
    • 3 - only links marked to hide (ignore until next check)
    • -1 - include all
  • limit=50 - maximum number of links (total)

Notes:

  • setting broken,working,warning on parked all to zero will show all links. Same as all=1
  • using both internal=1 and external=1 will result in an empty list.

 

Example, show only external links with a redirect (redirect=1 is the default value as well):

https://example.com/component/ajax/?plugin=blcReport&format=json&token=<your-token>&tmpl=component&redirect=1&broken=0&parked=0&warning=0&external=1