Using the Site Audit REST API

Use the Blue Refraction site audit REST API as part of your DevOps build and deploy process to check your site. Perform an audit of the target page looking at design, links, W3C compliance, security etc and more to produce a rating and report of the issues.

The site audit API takes 2 arguments:

  • site_url – to specify the URL encoded site address
  • fmt – to select the return format. Currently only JSON is supported

Below is an example of using the API with cURL:

curl "http://monitor.bluerefraction.com/checksite.aspx?site_url=http%3A%2F%2Fimagos.co&fmt=json"

Both GET and POST operations are supported. Please note that currently the API will only return results for the first page. Excessive use of the Restful API may result in getting blacklisted so please limit the call rate to the API.

Below is an example of the JSON output:

{
   "title": "Sites and Services Directory",
   "summary": {
      "Date": "1/03/2016 5:42:47 PM",
      "Response time": "00:00:00.2895265",
      "URL": "http://imagos.co",
      "Rating": "57.1"
   },
   "sections": [
      {
         "subsections": [
            {
               "title": "SEO checks",
               "items": {
                  "Document Type": "Ok",
                  "Page Title": "Ok",
                  "Page Description": "Missing",
                  "Images": "Ok",
                  "Heading Order": "Ok",
                  "Page Content": "Ok"
               }
            },
            {
               "title": "Security checks",
               "items": {
                  "X-XSS-Protection": "Missing X-XSS-Protection",
                  "X-Content-Type-Options": "Missing X-Content-Type-Options",
                  "X-Frame-Options": "Missing X-Frame-Options",
                  "X-Powered-By": "Ok"
               }
            },
            {
               "title": "Validate page Html",
               "message": "No issues found"
            }
         ]
      },
      {
         "title": "Check List",
         "rows": [
            {
               "Item": "Missing meta description tag",
               "Comments": "Add a meta description tag to your page"
            },
            {
               "Item": "Missing X-Frame-Options",
               "Comments": "Added this header to ..."
            },
            {
               "Item": "Missing X-content-Type-options",
               "Comments": "The only defined value..."
            },
            {
               "Item": "Missing X-XSS-Protection",
               "Comments": "Recent browsers have integrated ..."
            }
         ]
      }
   ]
}

Please let me know if you are using the API on a regular basis and would like to be notified of changes to the API. The interface is still in development and there may be changes in the future. The server may also be unavailable from time to time.

About

Terms of Use
Privacy Policy

Recent Blog Posts

Graphical site map
February 14, 2016

Logging Data to Blue Refraction
February 7, 2016

Simple daily site check
February 5, 2016

Testing your SEO back links

Track Your Site Rank in Google Analytics
February 25, 2016

Using the Site Audit REST API
February 27, 2016

Web site security audit
February 29, 2016

Get in Touch

  • Phone:
    1300 721 886
  • Email:
    Contact Us
  • Address:
    PO Box 169
    Cammeray, NSW
    Australia 2062