UKHSA-Internal/coronavirus-dashboard-api-python-sdk

Additional undocumented filter comparisons

infinnovation-dev opened this issue · 2 comments

By playing with the API, I find that comparisons other than = are supported in filters. For example, date>=2020-07-01 and date<2020-07-15 . To obtain results for e.g. all nations you can specify areaType=nation and areaCode!=Q (Q here is arbitrary; I find that omitting any filter for areaName or areaCode results in an error).

Assuming these comparisons are intended to be supported (perhaps they are experimental?), it would be good if they were documented.

Hi @infinnovation-dev

Well, they have been implemented intentionally, so they are indeed intended. But also yes, they are still experimental, which is why they haven't been formally released. They are really intended to be used against the date filter only. Well, they're not really useful when it comes to other filter metrics... In fact, they were initially implemented to facilitate data extraction between 2 specific dates.

One reason they have not be announced - for instance - is we have found that the use of conjunctive and disjunctive filters with the date metric tends to result in unexpected responses.

My main objective and priority right now is to enable the means to include multiple areaName / areaCode metrics. That seems to be a functionality that users really want. I received a suggestion from one of the users today - and it might just work.

Rest assured that we will document every single functionality / metric as soon as they pass QA.

Thanks for your quick response @xenatisch , I understand your situation. I'll note in passing that e.g. using areaCode>=W00000000 and areaCode<=W99999999 seems successfully to pick all Welsh areas.