Skip to main content

Create​

Create an analysis request

Request Body required
    text string

    The text to analyse.

    url string

    The URL to analyse.

    query string

    The query string to analyse.

    html string

    The html to analyse.

    language_code string

    Default value: en

    The language code used for content analysis, e.g. en.

    query_location_name string

    Default value: United States

    The location name for the query, e.g. United Kingdom.

    query_search_engine string

    The search engine domain for the query, if not set will be chosen according to query_location_name

    linked_data boolean

    Default value: true

    Whether to include results from Linked Data (e.g. DBpedia), by default true.

    local_data boolean

    Default value: true

    Whether to include results from the local Knowledge Graph, by default true.

    network_data boolean

    Default value: true

    Whether to include results from connected Knowledge Graphs, by default true.

Responses

Success

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.

  • ]
Loading...