Changes on the Report execution API

Jiri Tobolka

Please read this carefully if you are integrating GoodData API in your system and even more carefully if you generate the reports programatically! We are changing our Report execution API, this change is necessary for the future development and will be released in the Release 97 (~December 7th 2013).

If you execute the report using the Report URI, Report Definition URI, the Report Definition URI is returned at the bottom of the response content in execResult. There is no change at all. See the example:

{ 
"execResult" : ...
...
...
      },
      "reportDefinition" : "/gdc/md/eg9r9fvuyhljjyb2b7wy3h39tkwtfdck/obj/2592",
      "dataResult" : "/gdc/md/eg9r9fvuyhljjyb2b7wy3h39tkwtfdck/dataResult/2885088142122614272"
   }
}

But! If you directly POST Report Definition JSON (not URI but the content) the Report Definition will not be saved as persistent object and so the link won’t be returned in the Response execResult content.

{ 
"execResult" : ...
...
...
      },
      "dataResult" : "/gdc/md/eg9r9fvuyhljjyb2b7wy3h39tkwtfdck/dataResult/2885088142122614272"
   }
}

This means you can programatically create your report and execute it without saving the Report definition. This optimization allows us to provide you better performance in the future! Stay tuned!


About The Author

Jiri Tobolka Jiri Tobolka works as Developer Evangelist at GoodData and helps people use and build on the top of the GoodData Platform. He is using GoodData since the 2009. In the free time, Jiri enjoys action sports like kiteboarding or skiing.

Twitter @jirtob   Email jiri.tobolka@gooddata.com

Dev's Newsletter

Subscribe Now