Create

POST 
/entity-gaps

Create an Entity Gaps analysis.

Request

application/json

Body

required

url stringrequired

The URL to analyze.

query stringrequired

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

Found.

application/json

Schema

Schema

items

object[]

Array [

text string

The text matching the entity.

confidence double

Possible values: <= 1

The confidence score this is the right entity.

occurrences int32

The number of occurrences.

serp_position int32

The position of the entity in SERP. null if not applicable.

entity_id string

The entity id (URI).

entity_label string

The entity label.

entity_type string

The entity type.

entity_description string

The entity description.

]

Example (from schema)

{
  "items": [
    {
      "text": "string",
      "confidence": 0,
      "occurrences": 0,
      "serp_position": 0,
      "entity_id": "string",
      "entity_label": "string",
      "entity_type": "string",
      "entity_description": "string"
    }
  ]
}

401

Authentication Failure

application/json

Schema

Schema

items

object[]

Array [

text string

The text matching the entity.

confidence double

Possible values: <= 1

The confidence score this is the right entity.

occurrences int32

The number of occurrences.

serp_position int32

The position of the entity in SERP. null if not applicable.

entity_id string

The entity id (URI).

entity_label string

The entity label.

entity_type string

The entity type.

entity_description string

The entity description.

]

Example (from schema)

{
  "items": [
    {
      "text": "string",
      "confidence": 0,
      "occurrences": 0,
      "serp_position": 0,
      "entity_id": "string",
      "entity_label": "string",
      "entity_type": "string",
      "entity_description": "string"
    }
  ]
}

500

Uh oh, something went wrong

application/json

Schema

Schema

items

object[]

Array [

text string

The text matching the entity.

confidence double

Possible values: <= 1

The confidence score this is the right entity.

occurrences int32

The number of occurrences.

serp_position int32

The position of the entity in SERP. null if not applicable.

entity_id string

The entity id (URI).

entity_label string

The entity label.

entity_type string

The entity type.

entity_description string

The entity description.

]

Example (from schema)

{
  "items": [
    {
      "text": "string",
      "confidence": 0,
      "occurrences": 0,
      "serp_position": 0,
      "entity_id": "string",
      "entity_label": "string",
      "entity_type": "string",
      "entity_description": "string"
    }
  ]
}