https://github.com/bryanjos/keenex

Keen.io API Client for Elixir
https://github.com/bryanjos/keenex

Last synced: 2 months ago
JSON representation

Keen.io API Client for Elixir

• Host: GitHub
• URL: https://github.com/bryanjos/keenex
• Owner: bryanjos
• Created: 2014-12-07T16:44:06.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2018-10-26T12:04:48.000Z (about 6 years ago)
• Last Synced: 2024-11-01T09:34:51.340Z (2 months ago)
• Language: Elixir
• Size: 70.3 KB
• Stars: 28
• Watchers: 6
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md

Awesome Lists containing this project

• freaking_awesome_elixir - Elixir - A Keen.io API Client. (Third Party APIs)
• fucking-awesome-elixir - keenex - A Keen.io API Client. (Third Party APIs)
• awesome-elixir - keenex - A Keen.io API Client. (Third Party APIs)

README

        
# Keenex

[Documentation](http://hexdocs.pm/keenex)

Keenex provides an Elixir interface to the Keen.io HTTP API.

## Usage

Add it to your applications and dependencies in `mix.exs`:

    def deps do

      [{:keenex, "~> 1.1"}]

    end

Configure it in `config.exs`:

    config :keenex,

      project_id: "xxxxx",  # defaults to System.get_env("KEEN_PROJECT_ID")

      read_key:   "xxxxx",  # defaults to System.get_env("KEEN_READ_KEY")

      write_key:  "xxxxx",  # defaults to System.get_env("KEEN_WRITE_KEY")

      httpoison_opts: [timeout: 5000]  # defaults to []

And then call functions like:

    {status, response} = Keenex.add_event("dinner.tacos", %{test: "tacos"})

`status` is either `:ok` or `:error`.

`response` is a Map converted from the JSON response from Keen.

Information about the contents of the response can be found

[here](https://keen.io/docs/api/).