- App Search Guide: other versions:
- Installation
- Getting started
- Authentication
- Limits
- Users and access
- Guides
- Adaptive relevance events logs reference
- Analytics Tags
- Crawl web content
- Crawl a private network using a web crawler on Elastic Cloud
- Curations
- Facets
- Hierarchical Facets
- Indexing Documents
- Language Optimization
- Log settings
- Meta Engines
- Precision tuning (beta)
- Query Suggestions
- Search UI
- Relevance Tuning
- Result Settings
- Result Suggestions
- Role based access control (RBAC)
- Sanitization, Raw or Snippet
- Search
- Synonyms
- View web crawler events logs
- Web crawler
- Web crawler FAQ
- Web crawler reference
- Web crawler events logs reference
- API Reference
- Adaptive relevance API reference (beta)
- Analytics APIs
- Analytics clicks API
- Analytics counts API
- Analytics queries API
- API logs API
- Click API
- Credentials API
- Curations API reference
- Documents API
- Engines API
- Log settings API
- Multi search API
- Query suggestion API
- Schema API
- Search API
- Search API boosts
- Search API facets
- Search API filters
- Search API group
- Search API precision (beta)
- Search API result fields
- Search API search fields
- Search API sort
- Search API analytics tags
- Search settings API
- Source engines API
- Synonyms API
- Web crawler API (beta) reference
- API Clients
- Configuration
- Troubleshooting
A newer version is available. For the latest information, see the
current release documentation.
Click API
editClick API
editTrack which results were clicked after a query.
This information will be collected and shown in the Analytics tab of your App Search dashboard.
POST /api/as/v1/engines/{ENGINE_NAME}/click
-
query
(required) - The query that the user searched with.
-
document_id
(required) - The id of the document that was clicked on.
-
request_id
(optional) - The request id returned in the meta tag of a search API response.
-
tags
(optional) - Array of strings representing additional information you wish to track with the clickthrough. You may submit up to 16 tags, and each may be up to 64 characters in length.
Example
curl -X POST 'https://[instance id].ent-search.[region].[provider].cloud.es.io:443/api/as/v1/engines/national-parks-demo/click' \ -H 'Content-Type: application/json' \ -H 'Authorization: Bearer search-soaewu2ye6uc45dr8mcd54v8' \ -d '{ "query": "everglade", "request_id": "e4c4dea0bd7ad3d2f676575ef16dc7d2", "document_id": "park_zion", "tags": ["firefox", "web browser"] }'
What’s Next?
editClickthrough data is rich. Generate it from your applications for great insights into searcher behaviour. If you want to learn even more, the Analytics endpoint will provide a clear view into user search activity and document performance. If you want to start improving your results, consider reading about Synonyms and Curations.
On this page
Was this helpful?
Thank you for your feedback.