ℹ️ For new users, we recommend using our native Elasticsearch tools, rather than the standalone App Search product. We are actively developing new features and capabilities in the Elastic Stack to help you build powerful search applications. Refer to Elasticsearch feature recommendations for more information.
« Search API sort Search settings API »
Elastic Docs › ›API Reference

Search API analytics tags

edit

Search API analytics tags

edit

We have a Tags Guide, too.

Submit tags with the analytics parameter.

Tags can be used to enrich each query with unique information.

Once added, a tag cannot be removed.

Supports arrays.

You can view and filter by tags using the Analytics API or the dashboard.

tags (required)
Array of strings representing the tags you’d like to apply to the query. You may submit up to 16 tags, and each may be up to 64 characters in length.

Example - Submitting a query with the analytics tags "web" and "mobile".

curl -X GET '<ENTERPRISE_SEARCH_BASE_URL>/api/as/v1/engines/national-parks-demo/search' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer search-soaewu2ye6uc45dr8mcd54v8' \
-d '{
  "query": "everglade",
  "analytics": {
    "tags": [
      "web",
      "mobile"
    ]
  }
}'
« Search API sort Search settings API »