Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update endpoint documentations #543

Open
4 tasks done
sgratzl opened this issue May 14, 2021 · 0 comments
Open
4 tasks done

update endpoint documentations #543

sgratzl opened this issue May 14, 2021 · 0 comments

Comments

@sgratzl
Copy link
Member

sgratzl commented May 14, 2021

the new flask server supports new version of the endpoints, e.g. /api.php?endpoint=covidcast -> will become /covidcast/.

Those new versions have new features:

  • row limit up to 1M rows
  • delphi epidata return format, will always return an epidata element even if there are no rows given
  • better formats: ?format=csv, ?format=json which return plain versions and use HTTP status codes to communicate errors (e.g. 400 = bad request, in case of wrong parameter) -> I would consider ?format=json the better default
  • filter returned fields (include and exclude fields)
  • /version endpoint to show server information

In case of covidcast

  • new ways of specifying parameters: see [flask]: add new parameter version: signal,time,geo #481 -> query multiple sources/signal, multiple geo_types/values, times ... at once
  • new customized endpoints:
    • /meta ... alternative meta data format with more meta data about signals
    • /trend ... simple trend computation for a given date based on a given window
    • /trendseries ... trend computation for a series of dates at once
    • /correlation ... correlation between one and other signals
    • /backfill ... backfill information about all the issues of a signal
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant