Skip to main content

Create​

Create an analysis request

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.

Responses

Success

Schema
  • items object[]
  • Array [
  • text string required

    The text matching the entity.

  • confidence double required

    Possible values: <= 1

    The confidence score this is the right entity.

  • occurrences int32 required

    The number of occurrences.

  • serp_position int32 required

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

  • entity_id string required

    The entity id (URI).

  • entity_label string required

    The entity label.

  • entity_type string required

    The entity type.

  • entity_description string required

    The entity description.

  • ]
Loading...