Create
Create an analysis request
- application/json
Request Body required
- text string required
The text to analyse.
- url string required
The URL to analyse.
- query string required
The query string to analyse.
- html string required
The html to analyse.
- language_code string required
Default value:
en
The language code used for content analysis, e.g.
en
. - query_location_name string required
Default value:
United States
The location name for the query, e.g. United Kingdom.
- query_search_engine string required
The search engine domain for the query, if not set will be chosen according to
query_location_name
- linked_data boolean required
Default value:
true
Whether to include results from Linked Data (e.g. DBpedia), by default true.
- local_data boolean required
Default value:
true
Whether to include results from the local Knowledge Graph, by default true.
- network_data boolean required
Default value:
true
Whether to include results from connected Knowledge Graphs, by default true.
- 200
- 401
- 500
Success
- application/x.wordlift.analysis+json;version=3
- Schema
- Example (from schema)
Schema
items object[]
Array [text string requiredThe text matching the entity.
confidence double requiredPossible values:
<= 1
The confidence score this is the right entity.
occurrences int32 requiredThe number of occurrences.
serp_position int32 requiredThe position of the entity in SERP.
null
if not applicable.entity_id string requiredThe entity id (URI).
entity_label string requiredThe entity label.
entity_type string requiredThe entity type.
entity_description string requiredThe entity description.
]
{
"items": [
{
"text": "string",
"confidence": 0,
"occurrences": 0,
"serp_position": 0,
"entity_id": "string",
"entity_label": "string",
"entity_type": "string",
"entity_description": "string"
}
]
}
Unauthorized
- application/x.wordlift.analysis+json;version=3
- Schema
- Example (from schema)
Schema
items object[]
Array [text string requiredThe text matching the entity.
confidence double requiredPossible values:
<= 1
The confidence score this is the right entity.
occurrences int32 requiredThe number of occurrences.
serp_position int32 requiredThe position of the entity in SERP.
null
if not applicable.entity_id string requiredThe entity id (URI).
entity_label string requiredThe entity label.
entity_type string requiredThe entity type.
entity_description string requiredThe entity description.
]
{
"items": [
{
"text": "string",
"confidence": 0,
"occurrences": 0,
"serp_position": 0,
"entity_id": "string",
"entity_label": "string",
"entity_type": "string",
"entity_description": "string"
}
]
}
Uh oh, something went wrong
- application/x.wordlift.analysis+json;version=3
- Schema
- Example (from schema)
Schema
items object[]
Array [text string requiredThe text matching the entity.
confidence double requiredPossible values:
<= 1
The confidence score this is the right entity.
occurrences int32 requiredThe number of occurrences.
serp_position int32 requiredThe position of the entity in SERP.
null
if not applicable.entity_id string requiredThe entity id (URI).
entity_label string requiredThe entity label.
entity_type string requiredThe entity type.
entity_description string requiredThe entity description.
]
{
"items": [
{
"text": "string",
"confidence": 0,
"occurrences": 0,
"serp_position": 0,
"entity_id": "string",
"entity_label": "string",
"entity_type": "string",
"entity_description": "string"
}
]
}