Forum Discussion

Anonymous's avatar
Anonymous
Not applicable
6 years ago
Solved

Export to file - Power BI Report with Filters / Parameters

HI All, I am looking at the new (currently in preview) API for exporting Power BI reports as images/pdf files. https://docs.microsoft.com/en-us/rest/api/power-bi/reports/exporttofileingroup  T...
General Comment
Need Help
Anonymous's avatar
Anonymous
Not applicable
6 years ago

Anonymous 

latearrival 

I am using the REST APIs for ExportToFile in my Power Automate flow.

I can export the PDF with no issues in a normal use case, but next I want to try out exporting a PDF with a particular bookmark.

Use case is - I have 5 user groups and I will create 5 bookmarks (one for each).

Will send the PDF in an email to each of them as per their individual bookmarks.

 

However, when I try to put the bookmark name in my flow, it doesn't work.

Here is how my flow looks -

 

The error I get is -

{
  "error": {
    "code": "BadRequest",
    "message": "Bad Request",
    "details": [
      {
        "message": "Error converting value \"Group1_bookmark\" to type 'Microsoft.PowerBI.ServiceContracts.Api.V1.PageBookmark'. Path 'powerBIReportConfiguration.defaultBookmark', line 1, position 74.",
        "target": "request.powerBIReportConfiguration.defaultBookmark"
      }
    ]
  }
}
 
Appreciate if you can provide any inputs in case you have any ideas around this use case?
 
Regards
  • Anonymous's avatar
    Anonymous
    Not applicable
    6 years ago

    Hi Anonymous 

    The documentation currently states that the Bookmark name (whilst accepted as a parameter) is not currently available.
    https://docs.microsoft.com/en-us/rest/api/power-bi/reports/exporttofile#pagebookmark

    The only way to update output via bookmarks, is to pass in the bookmark state.
    And the only way that you can get the bookmark state (that I know of) is via the JavaScript API. https://github.com/Microsoft/PowerBI-JavaScript/wiki/Bookmarks#capture-and-get-a-current-view-as-a-bookmark-object-and-apply-it-back-on-the-current-session 

    The 'capture' function will return a single string value that represents the bookmark state. You can then pass this into the API.

    This is far from ideal... but I think the export API endpoint is still under preview, so will likely change quite a bit.

    The idea I raised for adding missing functionality to this API has also moved into the planned phase. So hopefully, it won't be too long before these missing features are available. https://ideas.powerbi.com/ideas/idea/?ideaid=0e056f7d-34b4-4778-974f-929228effcdd

    Cheers, Matt

    • Anonymous's avatar
      Anonymous
      Not applicable
      6 years ago

      Anonymous 

      Thanks for providing the details which I didn't know about.

       

      Hoping that this functionality is added soon.

       

      I have voted the idea.

       

      Regards

    • craigbenstock's avatar
      craigbenstock
      Regular Visitor
      5 years ago

      Hi,

      I'm posting here because I don't know if there has been an update to the docs since the original post was made.
      I also have a requirement where I would like to call "ExportTo" using the REST API from a Javascript AJAX request.
      In the docs (https://docs.microsoft.com/en-us/rest/api/power-bi/reports/exporttofile) it says that request body accepts powerBIReportConfiguration which in turn accepts a reportLevelFilters which is of type ExportFilter.
      According the docs an ExportFilter is a string in the format as described under the article https://docs.microsoft.com/en-us/power-bi/collaborate-share/service-url-filters       e.g.

      ?filter=Store/Territory eq 'NC'

      I've tried various permutations trying to get this to work but I never get a filter applied.
      Does anyone know...

      - Should this filter actually be working now?
      - What format the filter should be
      - An example of it in code

      Here's an example of an attempt that DOESNT work for reference:

       

      var url = "https://api.powerbi.com/v1.0/myorg/reports/" + reportId + "/ExportTo";
      $.ajax({
      "type": "POST",
      "url": url,
      "headers": {
      "Authorization": "Bearer " + accessToken
      },
      "data": {
      "format": "pdf",
      "powerBIReportConfiguration": {
      "reportLevelFilters": [{ "filter": "products/ProductName eq 'ExampleProductName'" }]
      }
      }
      })

      Cheers,

      Craig

      • AndrewLGoldman's avatar
        AndrewLGoldman
        Icon for Advocate I rankAdvocate I
        5 years ago

        I am running into the same issue as craigbenstock but only since December it seems - but it's weird since exporting to .pdf/.pptx seems to work fine in the Power BI Service, just it's no longer capturing filters/bookmark state over API calls - any ideas?