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

Add documentation for querying a Dataset #240

Open
tbarn opened this Issue Sep 27, 2017 · 0 comments

Comments

1 participant
@tbarn

tbarn commented Sep 27, 2017

In the 3.7.0 release, we added querying support for Datasets. You can find the code in the #233 PR.

Gets results from a cached dataset query, which can be a single or multi-analysis query.

Like the comments in the code say, you can find detailed API documentation for it here: https://keen.io/docs/api/?shell#retrieving-results-from-a-cached-dataset
And here: https://keen.io/docs/compute/cached-datasets/

It would be nice to have an example for it in the README.md though.

The JavaScript section of the API reference is a good example of these docs: https://keen.io/docs/api/?javascript#retrieving-results-from-a-cached-dataset

Let me know if you have any questions!

@tbarn tbarn added the hacktoberfest label Sep 29, 2017

@tbarn tbarn added hacktoberfest and removed hacktoberfest labels Oct 30, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment