Skip to content

Commit

Permalink
[Reporting] small documentation updates (elastic#190930)
Browse files Browse the repository at this point in the history
## Summary

This PR offers small updates to documentation on:
* Calling Kibana APIs to automate report generation
* Using Elasticsearch APIs directly to export data
  • Loading branch information
tsullivan authored Aug 21, 2024
1 parent 1949de0 commit c1e751d
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 3 deletions.
6 changes: 5 additions & 1 deletion docs/user/reporting/reporting-csv-limitations.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,8 @@ We recommend using CSV reports to export moderate amounts of data only. The feat
- Cross-cluster search is used
- ES|QL is used and result row count exceeds the limits of ES|QL queries
To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs. See {ref}/scroll-api.html[Scroll API], {ref}/point-in-time-api.html[Point in time API], {ref}/esql-rest.html[ES|QL] or {ref}/sql-rest-format.html#_csv[SQL] with CSV response data format. <<reporting-settings-kb, Reporting parameters>> can be adjusted to overcome some of these limiting scenarios. Results are dependent on data size, availability, and latency factors and are not guaranteed.
To work around the limitations, use filters to create multiple smaller reports, or extract the data you need directly with the Elasticsearch APIs.

For more information on using Elasticsearch APIs directly, see {ref}/scroll-api.html[Scroll API], {ref}/point-in-time-api.html[Point in time API], {ref}/esql-rest.html[ES|QL] or {ref}/sql-rest-format.html#_csv[SQL] with CSV response data format. We recommend that you use an official Elastic language client: details for each programming language library that Elastic provides are in the https://www.elastic.co/guide/en/elasticsearch/client/index.html[{es} Client documentation].
<<reporting-settings-kb, Reporting parameters>> can be adjusted to overcome some of these limiting scenarios. Results are dependent on data size, availability, and latency factors and are not guaranteed.
6 changes: 4 additions & 2 deletions docs/user/reporting/response-codes.asciidoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
The reporting APIs use HTTP response codes to give feedback. In automation,
this helps external systems track the various possible job states:
The response payload of a request to generate a report includes the path to
download a report. The API to download a report uses HTTP response codes to give
feedback. In automation, this helps external systems track the various possible
job states:

- **`200` (OK)**: As expected, Kibana returns `200` status in the response for
successful requests to queue or download reports.
Expand Down

0 comments on commit c1e751d

Please sign in to comment.