[Reporting] generate csv from new api for saved object ids

[tsullivan]

Summary

This PR explores a way of generating CSV using a new API that uses simple params in the query string and meaninful params in a POST body.

Usage

1. Create a TSVB Table
2. Call the API manually:

   POST /api/reporting/v1/generate/<endpoint>/<saved object id>
   {
     "timerange": {
       "timezone": "UTC",
       "min": "1972-01-01T07:00:00.000Z",
       "max": "2015-01-01T06:59:59.999Z"
     },
     "state": {}
   }
   

New API endpoints:

• /api/reporting/v1/generate/immediate/csv/saved-object/<id>
  • For on-demand download, e.g from panel action
  • CSV content and text/csv content-type header in the response
• /api/reporting/v1/generate/csv/saved-object/<id>:
  • For scheduling, similar to many Reporting integrations today.

For now, this can probably only support TSVB tables. Future expansion is possible, starting with visualization types that query / model their data on the server side.

Screenshot

TODO:

• Flatten the response data into CSV
• Use the actual label for the first column instead of term
• [ ] Fix sort See [Reporting] generate csv from new api for saved object ids #31188 (comment)
• Handle non-immediate

Release notes: none. This is an internal-only API until it is able to support more types of saved objects.

[tsullivan]

cc @joelgriffith

[joelgriffith]

Sorry to let this fall by the wayside, I'll take a gander on Monday morning! Hope is to get this in, then #30895 so we can use the types you've got!

[tsullivan]

@joelgriffith not a huge rush on this! I think
#30895 is probably more needed

[tsullivan]

Ok, I'm not so sure I want to take on a fix for sorting in this PR. Currently in master, TSVB is showing odd things for sort:

If TSVB table sorting is all happening on the client side, this API will have to be another layer of data modeling to sort the result data. Also, it will need to get the sorting options in the state object in POST params

[tsullivan]

Related to https://github.com/elastic/kibana/pull/31188/files#diff-413c6bc9d32af586a135bc6326d46cfbR109

[joelgriffith]

I'm going to be pulling/playing with this branch today, stay tuned

[tsullivan]

I'm going to be pulling/playing with this branch today, stay tuned

Cool! I think this is in usable shape for saved search by ID

[tsullivan]

TODO: use kibanaSavedObjectMeta.searchSourceJSON to get the filters

[joelgriffith]

Any reason it's uppercased here? Not sure if there's a semantic reason... my guess is not

[tsullivan]

it's also exported as a const and used elsewhere

[joelgriffith]

This looks good, and seems to be working well in my panel work. LGTM

[tsullivan]

@joelgriffith sorry I missed your review. I rewinded other changes I made back to the point that you reviewed

[elasticmachine]

💔 Build Failed

• continuous-integration/kibana-ci/pull-request

[tsullivan]

This PR was missing a file that was referenced. It was actually from a file rename. I pushed the fix in this commit: cc2a451940