{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"8f6348cf-fc05-466c-97fe-38df7303109e","name":"Woorank API","description":"The Woorank API provides website information data in a machine readable way. It is a REST API that returns JSON-encoded responses and uses standardized HTTP response codes, authentication, and verbs.\n\nThe API allows you to access all the information we collect about a website, including On-Page SEO factors (eg. title tag, meta-description, mobile optimization metrics, etc.) and Off-Page SEO factors (eg. traffic estimations, backlink data, etc.).\n\nA human-readable example of this information can be found on [the <i>etsy.com</i> WooRank review](https://shmz.1clkaccess.store/en/review/etsy.com) (make sure you are logged in with your WooRank account). It shows you the same information you'll retrieve from this API.\n\n# Authentication\n\nAll requests must be authenticated by including your secret API key in the request header `X-API-KEY`. A `401` error will be returned otherwise.\n\n```\ncurl 'https://shmz.1clkaccess.store/_sd_/api2/reviews?url=cnn.com' -H 'X-API-KEY: YOUR_API_KEY'\n\n ```\n\nTo get access to our API and receive a key please contact our team at [commercial@shmz.1clkaccess.store](https://mailto:commercial@shmz.1clkaccess.store).  \nThe API key should be treated as a secret and handled with care. Do not publicly share your API key or use it in client-side code.\n\n# Rate Limiting\n\nBy default the WooRank API rate limit is set to 1000 calls per hour per API key. Contact us to adjust this limit.\n\n# Date and Time\n\nAll date and time fields returned by this API are in [Unix Epoch Time](https://en.wikipedia.org/wiki/Unix_time) (milliseconds). There are a number of [tools and resources](https://www.epochconverter.com/) available to convert this to any format you need.\n\n# Images\n\nSome pieces of data returned by this API contain a reference to an image file (eg. website screenshots). These files should be treated ephemeral and you are not allowed to [hotlink](https://simple.wikipedia.org/wiki/Hotlinking) them.\n\nIf you want to use the images in your implementation, download them first and host them on your end. Hotlinking to or excessive accessing of these files is against our [Terms of Service (Art. 13)](https://shmz.1clkaccess.store/en/p/tos) and might get your API access suspended temporarily or indefinitely.\n\n# Data Integrity\n\nWhile we crawl and process millions of websites each day, we cannot guarantee that every website or URL can be crawled, processed and analyzed correctly, nor can we provide any feedback on the reason we couldn't.\n\nThe most common reasons crawling and processing data is slow, faulty, incomplete or failing altogether:\n\n- the requested URL is (temporarily) slow, unstable or down\n- the requested URL is blocked for our User-Agent and/or crawler (eg. robots.txt disallow, IP-based block, firewall, etc.)\n- the requested URL serves a different response to our User-Agent than to a human user/browser\n- the requested URL serves broken or inconsistent HTML\n    \n\n# Changelog\n\n## Dec 30, 2022\n\n- Refresh Review Data:\n    - Added `score` attribute to webhook response body\n- Create Review PDF:\n    - Added `score` attribute to webhook response body\n\n## Oct 13, 2022\n\n- Get Review Data:\n    - Added new criteria item `traffic_info` with properties:\n        - `monthlyVisits`: object with properties: `trend`, `visits`\n        - `topSources`: array of strings - sorted sources from highest to lowest. (possible values: `direct`, `search` , `social`, `referrals`, `mail`, `paidReferrals`)\n        - `topCountries`: array of strings - top three countries in ISO 3166-1 alpha-2 format\n\n## Feb 24, 2022\n\n- Get Review Data:\n    - `alexa`: Was renamed to `traffic_estimation`\n    - Added new criteria item `traffic_popularity`\n    - Deprecated criteria items `traffic_analysis` and `trafic_ranking`\n\n## Jul 30, 2021\n\n- Get Review Data:\n    - `schema_org`: Added a new data property `level` to `issues`\n\n## May 28, 2021\n\n- Get Review Data:\n    - Added new criteria item `image_optimization`\n\n## May 25, 2021\n\n- Get Review Data:\n    - Added new criteria item `largest_contentful_paint_element`\n\n## Apr 22, 2021\n\n- Added new `Metrics` API endpoint to get scoring history of a URL\n    \n\n## Apr 22, 2021\n\n- Get Review Data:\n    - Added new criteria item `layout_shift_elements`\n\n## Apr 20, 2021\n\n- Get Review Data:\n    - Added new criteria item `accessibility_navigation`\n\n## Apr 9, 2021\n\n- Get Review Data:\n    - Added new criteria item `core_web_vitals`\n\n## Mar 24, 2021\n\n- Get Review Data:\n    - Added new criteria item `accessibility_contrast`\n\n## Mar 18, 2021\n\n- Get Review Data:\n    - Added new criteria item `robots_tags`\n\n## Feb 9, 2021\n\n- Get Review Data:\n    - `mobile_rendering`: Deprecated `tablet` rendering, since search engines consider only desktop vs mobile, the data property will always return a `null` value\n\n## Jan 18, 2021\n\n- Get Review Data:\n    - `mobile_taptargets`: Changed data structure. The previous data structure is now contained into a new property `failingTapTargets`\n    - `mobile_fontsize`: Added a new data property `viewport`\n\n## Jan 7, 2021\n\n- Get Review Data:\n    - Added new data object in criteria `canonical_tags`","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"1776438","team":6408208,"collectionId":"8f6348cf-fc05-466c-97fe-38df7303109e","publishedId":"SzKWuHTb","public":true,"publicUrl":"https://shmz.1clkaccess.store/_sd_/apidocs","privateUrl":"https://go.postman.co/documentation/1776438-8f6348cf-fc05-466c-97fe-38df7303109e","customColor":{"top-bar":"2B5C86","right-sidebar":"000000","highlight":"2B5C86"},"documentationLayout":"classic-double-column","version":"8.10.1","publishDate":"2020-02-27T11:23:32.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/63607e4a8bdc4127c878ff07432285b551d98343c468c953caccd9ec28fefcf6","favicon":"https://shmz.1clkaccess.store/favicon.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://shmz.1clkaccess.store/_sd_/apidocs/view/metadata/SzKWuHTb"}