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.

Sign up for GitHub

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

Jump to bottom

Document new syntax features for covidcast endpoint #943

Closed
krivard opened this issue Jul 11, 2022 · 0 comments · Fixed by #1256
Closed

Document new syntax features for covidcast endpoint #943

krivard opened this issue Jul 11, 2022 · 0 comments · Fixed by #1256
Assignees
@minhkhul
Labels
documentation

Comments

@krivard
Copy link
Contributor

krivard commented Jul 11, 2022

We currently only disclose the backwards-compatible set of query parameters in the API documentation for covidcast:

However, several other useful ways of specifying which data to return are now supported, including:

  • signal={src}:{sig1},{sig2} - specify multiple source-signal pairs, grouped by source
  • time={type}:{val1},{val2} - specify multiple timetype-timevalue pairs, grouped by timetype
  • geo={type}:{val1},{val2} - specify multiple geotype-geovalue pairs, grouped by geotype

We should:

  • Examine the source code to figure out what new parameters are supported
  • Add their correct usage to the API documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@minhkhul minhkhul

Labels
documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

add syntax feature documentation cmu-delphi/delphi-epidata
2 participants
@krivard @minhkhul