Totally agree. Some time ago I also ran Blender headless with a script to render 'product shots' of a product that is available in over hundred different combinations. What is also very nice is that you can turn on API hints when you navigate over an element in the GUI. So you can quickly learn how to access or manipulate data.
Could you point me to some documentation for this? This has been the only hindrance for me to automate things without digging into the documentation myself
You can either switch to the "scripting" tab or just add/change any window to the "Scripting > Info" window. I personally change the animation timeline window to the info window on the main "Layout" tab since I don't do animations.