#4.2 URL/Website analysis

REQUEST BODY SCHEMA 

application/json

Input POST body should either be application/x-www-form-urlencoded or raw JSON.

hyScore|analyze Endpoint: https://api.hyscore.io/v3/url

POST BODY: v3/URL 

PARAMETER		DESCRIPTION
url Required!		Full URL of the website to be analyzed. (e.g. url=http://domain.com/folder/article001.html) Only use with API endpoint:  https://api.hyscore.io/v3/url The URL sent will be visited by the hyScore crawler (see https://hyScore.io/crawler). Content will be identified and analyzed. Example (raw JSON): {"url":"https://www.domain.com/article001.html"}
customData Optional		Type = String Optional parameter. Can contain any custom information, identifier, etc. We don't save this information but return it in the response so that you e.g. can match the result, enrich your user-profiles and enhance data sets. Example (raw JSON): {"url":"https://www.domain.com/article001.html", "customData":"web0477-2019"} {"url":"https://www.domain.com/article001.html", "customData":"&§!232-dsds_ASHDAS_9923?!!"} {"url":"https://www.domain.com/article001.html", "customData":"campain1_ad1"} {"url":"https://www.domain.com/article001.html", "customData":"network_a,website_012,url_3459"}
getText Optional		Type = Boolean  Optional parameter. Defines if the API should return the text gathered from URL and being analyzed.  Value = True/False, default value is "False". Example (raw JSON): {"url":"https://www.domain.com/article001.html", "getText":"True"}
imageDiv Optional		Type = Object Optional parameter. Instead of letting the system automatically choose the appropriate image, you can enter a css selector of the image div that should be used. Example (raw JSON): Example (raw JSON): {"url":"https://www.domain.com/article001.html", "imageDiv": "{\"parameter\":\"value\"}"} Parameter value example: {\"class\":\"part part-story\"} {\"id\":\"main-picture\"} {\"id\":\"galery-main-pic\"}
articleDiv Optional		Type = Object Optional parameter. Allows you to specify which part of the website should be analyzed, instead of the whole website. Example (raw JSON): {"url":"https://www.domain.com/article001.html", "articleDiv":"{\"parameter\":\"value\“}“}  Parameter value example: {\"class\":\"part part-story\"} {\"id\":\"main-news\"} {\"id\":\"article-news\"}
Optional: segments - please take a look at hyScore|segments documentation.
Example		curl request example POST /v3/url HTTP/1.1 Host: api.hyscore.io Content-Type: application/x-www-form-urlencoded x-api-key: API_KEY Authorization: Basic Og== cache-control: no-cache url=https%3A%2F%2Fwww.theguardian.com %2Fworld%2F2018%2Fnov%2F08%2Ftrump- administration-blocks-asylum-claims- by-those-crossing-border-illegally