Analyse Web Page
Analyse the content of a webpage by using the url
property of the request.
- application/json
Request Body required
html object
The html fragment or html page to analyze.
fragment string requiredThe html fragment to analyze.
page string requiredThe html page to analyze, either fragment or page should be present
- url url required
The url of the page to analyze.
- urlClient string required
Possible values: [
CHROME
,PLAIN_HTTP
,CHROME, PLAIN_HTTP
]The client which the analysis should use to extract the content, by default chrome is used.
- language string required
Possible values:
>= 2 characters
and<= 2 characters
The content language, 2 letters code, e.g. 'en'.
- text string required
A textual fragment.
- exclude url[] required
An array of item IDs to exclude from the analysis results.
- scope string required
The scope of the analysis, one of 'local', 'network', 'cloud-only', 'network-only' or 'all'.
- matches int32 required
Filter out results that don't have at least the specified number of occurrences. By default 1.
- links string required
When returning an interpolated HTML results, matches should have the 'wl-link' class. By default 'no'.
- 200
- 401
- 500
Success
- application/json
- Schema
- Example (from schema)
Schema
entities object
A map of entity URI to the respective entity.
property name*
objectannotations object
A map of annotation id to the respective annotation.
property name*
objectimages object[]
A list of images.
Array [label string requiredThe title of the image.
url url requiredThe image URI.
]- languages string[] required
A list of languages.
topics object[]
A list of topics.
Array [label string requiredThe topic title.
description string requiredThe topic description.
uri url requiredThe topic URI.
confidence double requiredThe topic confidence score.
images url[] requiredA list of image URIs.
sameAs url[] requiredA list of sameas URIs.
]- content string required
The text supplied for analysis.
{
"entities": {},
"annotations": {},
"images": [
{
"label": "string",
"url": "string"
}
],
"languages": [
"string"
],
"topics": [
{
"label": "string",
"description": "string",
"uri": "string",
"confidence": 0,
"images": [
"string"
],
"sameAs": [
"string"
]
}
],
"content": "string"
}
Authentication Failure
Server Error