watcher-stats.asciidoc 981 B

123456789101112131415161718192021222324252627282930313233
  1. --
  2. :api: watcher-stats
  3. :request: WatcherStatsRequest
  4. :response: WatcherStatsResponse
  5. --
  6. [role="xpack"]
  7. [id="{upid}-{api}"]
  8. === Get Watcher stats API
  9. [id="{upid}-{api}-request"]
  10. ==== Execution
  11. {ref}/watcher-api-stats.html[Watcher Stats] returns the current {watcher} metrics.
  12. Submit the following request to get the stats:
  13. ["source","java",subs="attributes,callouts,macros"]
  14. --------------------------------------------------
  15. include-tagged::{doc-tests-file}[{api}-request]
  16. --------------------------------------------------
  17. [id="{upid}-{api}-response"]
  18. ==== Response
  19. The returned `AcknowledgeResponse` contains a value on whether or not the request
  20. was received:
  21. ["source","java",subs="attributes,callouts,macros"]
  22. --------------------------------------------------
  23. include-tagged::{doc-tests-file}[{api}-response]
  24. --------------------------------------------------
  25. <1> A boolean value of `true` if successfully received, `false` otherwise.
  26. include::../execution.asciidoc[]