github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

[Reporting] small documentation updates (#190930)

Browse source 
## Summary

This PR offers small updates to documentation on:
* Calling Kibana APIs to automate report generation
* Using Elasticsearch APIs directly to export data
This commit is contained in:
Tim Sullivan 2024-08-21 09:36:22 -07:00 • committed by GitHub
parent 1949de076a
commit c1e751d9ff
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 9 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/user/reporting/reporting-csv-limitations.asciidoc
View file

@ -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
docs/user/reporting/response-codes.asciidoc
View file

@ -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.