query the API via individual observations (and filters)

[fiona-grimm]

Consider adding option to also query the API via individual observations (and filters)?

To take weekly deaths as an example, take the latest version URL and add /dimensions
https://api.beta.ons.gov.uk/v1/datasets/weekly-deaths-local-authority/editions/time-series/versions/15/dimensions

This shows you the available dimensions. You’ll need to put an option in for each dimension. You can call /dimensions/[dimension]/options to get a list of available options for a dimension.

Here is a valid call to the observations API:
https://api.beta.ons.gov.uk/v1/datasets/weekly-deaths-local-authority/editions/time-series/versions/15/observations?time=2020&geography=E08000003&placeofdeath=hospital&causeofdeath=all-causes&registrationoroccurrence=registrations&week=week-15

You can also put a wildcard * operator in one dimension e.g.
https://api.beta.ons.gov.uk/v1/datasets/weekly-deaths-local-authority/editions/time-series/versions/15/observations?time=2020&geography=E08000003&placeofdeath=hospital&causeofdeath=all-causes&registrationoroccurrence=registrations&week=*

[henryn218]

Hi! I don't know if this is of interest at all but I stumbled across this repo while building my own R client for the ONS API. The package I'm building can both filter data sets or get full ones as you've described: https://github.com/hamstr147/onsRapi

Anyway - it's just a personal project of mine rather than anything important so feel free to use or pillage it as much as you like! Also happy to raise a PR here if you think that functionality is useful and you'd like another pair of hands to help out.

[emmavestesson]

Hi @hamstr147

If you would like to file a PR that would be great! I've had a look at your code and it looks great. We would probably want to make some minor changes to make the terminology consistent but I don't think it would be too much work.