search mobile facets autocomplete spellcheck crawler rankings weights synonyms analytics engage api customize documentation install setup technology content domains user history info home business cart chart contact email activate analyticsalt analytics autocomplete cart contact content crawling custom documentation domains email engage faceted history info install mobile person querybuilder search setup spellcheck synonyms weights engage_search_term engage_related_content engage_next_results engage_personalized_results engage_recent_results success add arrow-down arrow-left arrow-right arrow-up caret-down caret-left caret-right caret-up check close content conversions-small conversions details edit grid help small-info error live magento minus move photo pin plus preview refresh search settings small-home stat subtract text trash unpin wordpress x alert case_deflection advanced-permissions keyword-detection predictive-ai sso
App Search Documentation / app search: Tags
Tags

From Zero to Search

Guides

API Reference

App Search API Clients

Self-Managed App Search

Resources

Tags

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 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Example - Submitting a query with the analytics tags "web" and "mobile".
No Java example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Example - Submitting a query with the analytics tags "web" and "mobile".
No Node example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Example - Submitting a query with the analytics tags "web" and "mobile".
No Ruby example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Example - Submitting a query with the analytics tags "web" and "mobile".
No Python example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Example - Submitting a query with the analytics tags "web" and "mobile".
No Javascript example available, showing cURL 
curl -X GET 'https://host-2376rb.api.swiftype.com/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"
    ]
  }
}'

Stuck? Looking for help? Contact support or check out the App Search community forum!