Explore graph analytics

POST also GET /{index}/_graph/explore

Extract and summarize information about the documents and terms in an Elasticsearch data stream or index. The easiest way to understand the behavior of this API is to use the Graph UI to explore connections. An initial request to the _explore API contains a seed query that identifies the documents of interest and specifies the fields that define the vertices and connections you want to include in the graph. Subsequent requests enable you to spider out from one more vertices of interest. You can exclude vertices that have already been returned.

Learn more about graphs

Path Parameters

index union IndexName | [] IndexName required: Name of the index.

Query Parameters

Request

Response

application/json

Examples

Run POST clicklogs/_graph/explore for a basic exploration An initial graph explore query typically begins with a query to identify strongly related terms. Seed the exploration with a query. This example is searching clicklogs for people who searched for the term midi.Identify the vertices to include in the graph. This example is looking for product codes that are significantly associated with searches for midi. Find the connections. This example is looking for other search terms that led people to click on the products that are associated with searches for midi.

Request Console 1 / 8 languages

Console Kibana Dev Tools

POST clicklogs/_graph/explore
{
  "query": {
    "match": {
      "query.raw": "midi"
    }
  },
  "vertices": [
    {
      "field": "product"
    }
  ],
  "connections": {
    "vertices": [
      {
        "field": "query.raw"
      }
    ]
  }
}

JavaScript Elasticsearch JavaScript Client

const response = await client.graph.explore({
  index: "clicklogs",
  query: {
    match: {
      "query.raw": "midi",
    },
  },
  vertices: [
    {
      field: "product",
    },
  ],
  connections: {
    vertices: [
      {
        field: "query.raw",
      },
    ],
  },
});

Python Elasticsearch Python Client

resp = client.graph.explore(
    index="clicklogs",
    query={
        "match": {
            "query.raw": "midi"
        }
    },
    vertices=[
        {
            "field": "product"
        }
    ],
    connections={
        "vertices": [
            {
                "field": "query.raw"
            }
        ]
    },
)

curl Shell

curl -X POST "$ELASTICSEARCH_URL/clicklogs/_graph/explore" \
  -H "Authorization: ApiKey $ELASTIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "query": {
      "match": {
        "query.raw": "midi"
      }
    },
    "vertices": [
      {
        "field": "product"
      }
    ],
    "connections": {
      "vertices": [
        {
          "field": "query.raw"
        }
      ]
    }
  }'

Java Elasticsearch Java Client

client.graph().explore(e -> e
    .connections(c -> c
        .vertices(v -> v
            .field("query.raw")
        )
    )
    .index("clicklogs")
    .query(q -> q
        .match(m -> m
            .field("query.raw")
            .query(FieldValue.of("midi"))
        )
    )
    .vertices(v -> v
        .field("product")
    )
);

C# Elasticsearch .NET Client

var response = await client.Graph
    .ExploreAsync(indices: new[] { "clicklogs" }, d1 => d1
        .Connections(d2 => d2
            .Vertices(d3 => d3
                .Field(x => x.Query.Raw)
            )
        )
        .Query(d2 => d2
            .Match(d3 => d3
                .Field(x => x.Query.Raw)
                .Query("midi")
            )
        )
        .Vertices(d2 => d2
            .Field(x => x.Product)
        )
    );

PHP Elasticsearch PHP Client

$resp = $client->graph()->explore([
    "index" => "clicklogs",
    "body" => [
        "query" => [
            "match" => [
                "query.raw" => "midi",
            ],
        ],
        "vertices" => array(
            [
                "field" => "product",
            ],
        ),
        "connections" => [
            "vertices" => array(
                [
                    "field" => "query.raw",
                ],
            ),
        ],
    ],
]);

Ruby Elasticsearch Ruby Client

response = client.graph.explore(
  index: "clicklogs",
  body: {
    "query": {
      "match": {
        "query.raw": "midi"
      }
    },
    "vertices": [
      {
        "field": "product"
      }
    ],
    "connections": {
      "vertices": [
        {
          "field": "query.raw"
        }
      ]
    }
  }
)

Response

No example

Path Parameters

Query Parameters { routing , timeout , }

Request { connections , controls , query , vertices , }

Response

Query Parameters

Request