Programmatically download scheduled reports

alexz00 · June 23, 2021, 11:18am

Hi,
once a scheduled report definition is created, is there a way to download the generated reports programmatically? (e.g. via GET request etc.)

Thanks,
Alessandro

searchymcsearchface · June 23, 2021, 2:59pm

So, Dashboards itself uses /api/reporting/reports to get that data.

You can, in theory, call OpenSearch Dashboards API endpoints using curl, but I’ve never really had much success getting auth right from curl (although it’s only be a bit of tinkering on my part, nothing serious). @reporting-team, care to chime in?

See code:
(API_PREFIX = /api/reporting):

github.com

opensearch-project/dashboards-reports/blob/4534be94b729030031674883cb5030767465aed3/dashboards-reports/server/routes/report.ts#L250


      
                  `Failed to generate report from reportDefinition id ${reportDefinitionId} : ${error}`
                );
                logger.error(error);
                addToMetric('report', 'create_from_definition', checkErrorType(error));
                return errorResponse(response, error);
              }
            }
          );
          
          
// get all reports details
          router.get(
            {
              path: `${API_PREFIX}/reports`,
              validate: {
                query: schema.object({
                  fromIndex: schema.maybe(schema.number()),
                  maxItems: schema.maybe(schema.number()),
                }),
              },
            },
            async (

alexz00 · June 25, 2021, 10:26am

Thanks, do you have an example of how I can use this API to download a specific report (e.g. a PDF)?

disha27 · September 21, 2021, 12:51pm

Do Opendistro has documentation for how to use reporting API’s.
The API’s are for internal kibana usage right?, will we able to access it from outside?

I also have a requirement to send a reports as a attachment via mail or webhoook.
As notification plugin is not yet released, how can we use reporting API’s to implement some code snippet do generate reports?

searchymcsearchface · September 22, 2021, 2:11pm

The Reporting APIs aren’t public, so they can change at any moment. Can you do a report trigger (cron, etc.)?

Topic		Replies	Views
Generate PDF and/or PNG reports from a dashboard with filters via API? OpenSearch	1	159	January 31, 2024
Unable to downloaded report Reporting Plugin	3	557	January 31, 2023
Are PDF reports from Reporting plugin saved somewhere in the backend? OpenSearch reporting	3	194	October 9, 2023
Issue downloading report as PDF scheduled in Reporting through python client OpenSearch	0	33	April 11, 2024
opensearch dashboards report generate is not working Reporting Plugin feature-request	2	223	February 15, 2024

Programmatically download scheduled reports

Related Topics