Endpoints for Event Collections and Collection Properties

[chiplay]

We're looking to build out a client-side dashboard and would love the ability to fetch a list of our event collections and their respective properties for use in UI dropdowns for constructing queries / funnels. Any chance those could make it into the js lib?

[maggiejan]

Hi Chip!

Yes, you can build a dashboard to display particular queries. There's a sample dashboard found in the Keen docs: https://keen.io/docs/data-visualization/#dashboard-template

I think you'll also find this helpful (this isn't really officially launched yet) but there are more examples and sample layouts you can reference while you're building your own custom client-facing dashboard: http://keenlabs.github.io/dashboards/!

[joshed-io]

Thanks @maggiejan for dashboard examples!

RE: the collections, @chiplay – would wrapping these endpoints do the trick?

• https://keen.io/docs/api/reference/#projects-resource
• https://keen.io/docs/api/reference/#event-collection-resource

[chiplay]

@maggiejan Thanks for the resource links!

@dzello That would work great! This one also seems useful for what we're looking to do - but using the two above should achieve the same result, just more API calls each time a new event collection is selected: https://keen.io/docs/api/reference/#event-resource

[dustinlarimer]

#179 gets us a lot closer to this.. just need to figure out where to put these methods within the library, and what to call them. @dzello any ideas?

[joshed-io]

Methods outside of a project context could sit on the namespace, and methods w/ a project context could live on the client instance. The methods could be named similarly to the API resource but with a verb and some modifications for clarity:

// namespace methods
Keen.getProjects()
Keen.getProject("my-project-id")

// client methods, all use the client-configured project ID
keenClient.getProject()
keenClient.getCollection("my-collection")
keenClient.getCollections()

What do you think?

[dustinlarimer]

👍 I dig it, should we add getProperties method as well?

[joshed-io]

Yeah, or getProperty?

keenClient.getProperty("my-collection", "my-property")

getProperties is functionally equivalent to getCollection I believe.

[dustinlarimer]

Ahh, ok – sounds good!

On Thu, Oct 16, 2014 at 12:36 PM, Josh Dzielak notifications@github.com
wrote:

Yeah, or getProperty?

keenClient.getProperty("my-collection", "my-property")

getProperties is functionally equivalent to getCollection I believe.

—
Reply to this email directly or view it on GitHub
#139 (comment).

[dustinlarimer]

released in v3.2 https://github.com/keen/keen-js/blob/master/docs/meta.md