Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[7.x] [DOCS] Added images to automating report generation (#64333) #64353

Merged
merged 1 commit into from
Apr 23, 2020
Merged

[7.x] [DOCS] Added images to automating report generation (#64333) #64353

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added docs/images/report-automate-csv.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/report-automate-pdf.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 26 additions & 16 deletions docs/user/reporting/automating-report-generation.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,42 @@
[role="xpack"]
[[automating-report-generation]]
== Automating report generation
You can automatically generate reports with {watcher}, or by submitting
HTTP `POST` requests from a script.
Automatically generate PDF and CSV reports by submitting HTTP `POST` requests using {watcher} or a script.

include::report-intervals.asciidoc[]

[float]
=== Get the POST URL
=== Create a POST URL

Generating a report either through {watcher} or a script requires capturing the **POST
URL**, which is the URL to queue a report for generation.
Create the POST
URL that triggers a report to generate.

To get the URL for triggering PDF report generation during a given time period:
To create the POST URL for PDF reports:

. Load the saved object in *Visualize* or *Dashboard*.
. To specify a relative or absolute time period, use the time filter.
. In the {kib} toolbar, click *Share*.
. Select *PDF Reports*.
. Click **Copy POST URL**.
. Go to *Visualize* or *Dashboard*, then open the visualization or dashboard.
+
To specify a relative or absolute time period, use the time filter.

To get the URL for triggering CSV report generation during a given time period:
. From the {kib} toolbar, click *Share*, then select *PDF Reports*.

. Click *Copy POST URL*.
+
[role="screenshot"]
image::images/report-automate-pdf.png[Generate Visualize and Dashboard reports]


To create the POST URL for CSV reports:

. Load the saved search in *Discover*.
. To specify a relative or absolute time period, use the time filter.
. In the {kib} toolbar, click *Share*.
. Select *CSV Reports*.
. Click **Copy POST URL**.
+
To specify a relative or absolute time period, use the time filter.

. From the {kib} toolbar, click *Share*, then select *CSV Reports*.

. Click *Copy POST URL*.
+
[role="screenshot"]
image::images/report-automate-csv.png[Generate Discover reports]

[float]
=== Use Watcher
Expand Down