# beachfront-api

> A simple module for accessing beachfront's report data.

Latest version **2.0.1** (published 2017-07-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install beachfront-api
pnpm add beachfront-api
yarn add beachfront-api
bun add beachfront-api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2017-07-12 |
| First published | 2017-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Ryan Loomba |
| Maintainers | rloomba |
| Keywords | beachfront |

## Links

- npm: https://www.npmjs.com/package/beachfront-api
- Repository: https://github.com/rloomba/beachfront-api
- Homepage: https://github.com/rloomba/beachfront-api#readme
- Issues: https://github.com/rloomba/beachfront-api/issues
- npm.io page: https://npm.io/package/beachfront-api

## Dependencies (1)

- [jsonist](https://npm.io/package/jsonist.md) ^1.3.0

## Recent versions

- 2.0.1 (latest) — 2017-07-12
- 1.0.0 — 2017-06-26

## README

# beachfront-api #

A simple module for accessing beachfront report data, inspired heavily by @davidguttman's [lkdq-api](https://github.com/davidguttman/lkqd-api).

## Example ##

```js
var bf = require('beachfront-api')

var token = 'abcdef0123456789'

var data = {
  "keys": ["adid"],
  "metrics": ["ctr"],
  "fromDate": "2017-05-01",
  "toDate": "2017-05-31"
}

bf(token, date, function (err, rows) {
  if (err) return console.error(err)

  console.log('ctr data', rows)
})

```

# License #

MIT

---
_Source: https://npm.io/package/beachfront-api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._