Documentation & Code Examples

Example (PHP):

$api_url = 'https://mysiteauditor.com/api/v1';

$params = array(
	'api_key' => '127369FB40CA3A04C657971E41C48B19ED4FDF43',
	'language' => 'english',
	'url' => 'http://yahoo.com',
	'competitor_url' => 'http://google.com',
	'keyword' => 'search engine',
	'callback' => 'https://example.com/callback.php'
);

$post_string = json_encode($params);					

$request = curl_init($api_url);
curl_setopt($request, CURLOPT_HEADER, 0);
curl_setopt($request, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($request, CURLOPT_FOLLOWLOCATION, TRUE);
curl_setopt($request, CURLOPT_POSTFIELDS, $post_string);
curl_setopt($request, CURLOPT_POST, 1);
$post_response = curl_exec($request);
curl_close ($request);

$post_response = json_decode($post_response);

var_dump($post_response);

Example response:

{"status":"ok","type":"single","audit_id":"6108805115","usage":"17","quota":"2500"}

Callback response

Example callback script (PHP):

$post_input = file_get_contents('php://input');
$data = json_decode($post_input,true); 

// validate API key to authenticate callback
$my_key = '127369FB40CA3A04C657971E41C48B19ED4FDF43';
if ($data['api_key'] != $my_key) {
	die('Invalid callback.');
}

$audit_data = $data['audit_data'];
$pdf = $data['audit_pdf'];

// do something with $audit_data and/or $pdf...

Example response data array:

$data = Array
(
    [api_key] => 127369FB40CA3A04C657971E41C48B19ED4FDF43
    [audit_id] => 6108805115
    [language] => english
    [url] => http://yahoo.com
    [competitor_url] =>
    [keyword] => search engine
    [audit_pdf] => https://mysiteauditor.com/api/v1/pdf/6108805115.pdf
    [audit_data] => Array
        (
            [total_grade] => 36
            [screenshot] => https://mysiteauditor.com/api/v1/screenshot/6108805115.png
            [mobile_screenshot] => https://mysiteauditor.com/api/v1/mobile_screenshot/6108805115.png
            [good_signals] => 15
            [bad_signals] => 39
            [domain] => Array
                (
                    [url_domain] => yahoo.com
                    [domain_expires] => 6 years, 31 days
                    [domain_expiration_ok] => 1
                    [domain_age] => 11 years, 222 days
                    [domain_creation_ok] => 1
                    [www_redirect] => to_www
                    [ip_canonicalization] => 1
                    [ip_blacklisted] =>
                    [alexa_rank] => 4
                    [has_favicon] => 1
                    [has_robots_txt] => 1
                    [has_sitemap_html] => 1
                    [has_sitemap_xml] => 1
                    [total_indexed_pages] => 0
                    [dir_yahoo] => 1
                    [dir_dmoz] => 1
                    [google_blog] => 1
                    [tweets_number] => 1010
                    [linkedin_number] => 432
                    [facebook_likes_number] => 186002
                    [google_plus_number] => 598892
                    [has_apple_icon] =>
                    [mobile_sitemap] => 1
                )

            [page] => Array
                (
                    [friendly_url] => 1
                    [keyword_in_url] =>
                    [url_includes_underscores] => 0
                    [google_pagerank] => 9
                    [is_homepage] =>
                    [page_load_time] => 2.79
                    [page_size] => 858606
                    [total_requests] => 83
                    [inbound_links] => 0
                    [tweets_number_page] => 1010
                    [linkedin_number_page] => 123
                    [facebook_likes_number_page] => 186002
                    [google_plus_number_page] => 598892
                    [mobile_css] =>
                    [mobile_redirect] =>
                    [content] => Array
                        (
                            [viewport_tag] =>
                            [top_keywords] =>  a:5:{i:0;a:1:{s:7:" search";i:4;}i:1;a:1:{s:6:" yahoo";i:3;}i:2;a:1:{s:9:" thursday";i:1;}i:3;a:1:{s:6:" march";i:1;}i:4;a:1:{s:5:" sign";i:1;}}
                            [title_tag_text] => Yahoo
                            [keyword_in_title_tag] =>
                            [keyword_starts_title_tag] =>
                            [title_tag_length] => 5
                            [description_tag_text] => A new welcome to Yahoo. The new Yahoo experience makes it easier to discover the news and information that you care about most. It's the web ordered for you.
                            [keyword_in_description_tag] =>
                            [keyword_starts_description_tag] =>
                            [description_tag_length] => 300
                            [has_headings] => 1
                            [has_h1] => 1
                            [has_h2] => 1
                            [has_h3] => 1
                            [has_h4] => 1
                            [has_h5] =>
                            [has_h6] =>
                            [h1_text] => Yahoo
                            [h2_text] => Thursday, March 5, 2015
                            [h3_text] => Sign in to save your preference.
                            [keyword_in_headings] => 0
                            [duplicate_headings] => 0
                            [keyword_starts_h1] =>
                            [is_wc3_valid] =>
                            [has_video] =>
                            [has_flash] => 1
                            [has_js] => 1
                            [has_css] => 1
                            [text_html_ratio] => 0
                            [lines_of_code] => 1050
                            [has_rel_author] => 0
                            [has_schema_org] => 0
                            [wordcount] => 1945
                            [keyword_frequency] => 0
                            [keyword_in_first_100_words] => 0
                            [keyword_in_anchor_text] => 0
                            [keyword_in_bold_italic_underline] =>
                            [keyword_in_image_alt_tag] =>
                            [keyword_in_image_filename] =>
                            [total_images] => 74
                            [missing_image_alt_text] => 1
                            [image_includes_underscores] => 1
                            [has_tweet_button] => 1
                            [has_googleplus_button] =>
                            [has_facebook_button] => 0
                            [has_google_analytics] => 1
                            [has_crazy_egg] =>
                        )

                )

            [links] => Array
                (
                    [total_links_on_page] => 113
                    [nofollow_links_on_page] => 2
                    [total_links_on_homepage] => 109
                    [nofollow_links_on_homepage] => 0
                    [links_from_external_domains] => 740075
                    [unique_sites_linking_from_external_domains] => 77358
                    [links_to_domain_from_external_domains] => 301740772
                    [uniques_sites_linking_to_domain_from_external_domains] => 1946564
                    [keyword_links_from_same_domain] => 0
                    [keyword_links_from_external_domains] => 0
                    [unique_sites_linking_with_keyword_from_external_domains] => 0
                    [moztrust_page] => 7.1
                    [mozrank_page] => 7.67
                    [moztrust_domain] => 8.56
                    [mozrank_domain] => 8.56
                    [moz_page_authority] => 95.02
                    [moz_domain_authority] => 100
                )

        )

)