Create
Create an Entity Gaps analysis.
application/json
Request Body required
url string required
The URL to analyze.
query string required
The search query to analyze.
model string
The model
number_of_entities int32
Default value: 5
Number of entities to highlight.
query_location_name string
Default value: United States
The location name for the query, e.g. United Kingdom.
query_search_engine string
Default value: google.com
The search engine domain for the query, if not set will be chosen according to query_location_name
Responses
- 200
- 401
- 500
Found.
application/json
Schema
Example (from schema)
Schema
items object[]
{
"items": [
{
"text": "string",
"confidence": 0,
"occurrences": 0,
"serp_position": 0,
"entity_id": "string",
"entity_label": "string",
"entity_type": "string",
"entity_description": "string"
}
]
}
Authentication Failure
application/json
Schema
Example (from schema)
Schema
items object[]
{
"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/json
Schema
Example (from schema)
Schema
items object[]
{
"items": [
{
"text": "string",
"confidence": 0,
"occurrences": 0,
"serp_position": 0,
"entity_id": "string",
"entity_label": "string",
"entity_type": "string",
"entity_description": "string"
}
]
}
POST /entity-gaps
Authorization
name: Authorizationtype: apiKeyin: header
Request
Request
curl / cURL
curl -L -X POST 'https://api.wordlift.io/analysis/entity-gaps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"url": "string",
"query": "string",
"model": "string",
"number_of_entities": 5,
"query_location_name": "United Kingdom",
"query_search_engine": "google.co.uk"
}'
python / requests
curl -L -X POST 'https://api.wordlift.io/analysis/entity-gaps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"url": "string",
"query": "string",
"model": "string",
"number_of_entities": 5,
"query_location_name": "United Kingdom",
"query_search_engine": "google.co.uk"
}'
nodejs / axios
curl -L -X POST 'https://api.wordlift.io/analysis/entity-gaps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"url": "string",
"query": "string",
"model": "string",
"number_of_entities": 5,
"query_location_name": "United Kingdom",
"query_search_engine": "google.co.uk"
}'
php / cURL
curl -L -X POST 'https://api.wordlift.io/analysis/entity-gaps' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>' \
--data-raw '{
"url": "string",
"query": "string",
"model": "string",
"number_of_entities": 5,
"query_location_name": "United Kingdom",
"query_search_engine": "google.co.uk"
}'