Back to top

borda

borda is an API for publishing measurements to Lantern’s influxdb measurements repository. One can domain front to borda using https://d157vud77ygy87.cloudfront.net.

There’s a postman.dump available for use with the Postman HTTP test utility.

Measurement

Measurements

Publish a measurement
POST/measurements

This publishes one or more measurements in a list. Each measurement has:

  • name (string) - The name of the measurement, e.g. “client_results”

  • ts (string) - The timestamp of the measurement as an ISO8601 string, e.g. “2007-04-05T14:30:25.711725Z”

  • values (map) - A map of measurement values (numbers).

  • dimensions (map) - A map of measurement dimensions (metadata). Values can be numbers, booleans or strings.

Example URI

POST https://borda.getlantern.org/measurements
Request
HideShow
Headers
Content-Type: application/json
Body
[
  {
    "name": "client_results",
    "ts": "2007-04-05T14:30:25.711725Z",
    "values": {
      "num_errors": 5,
      "num_successes": 987
    },
    "dimensions": {
      "client": "32DFS324DSFDSF",
      "proxy": "185.234.23.2",
      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.94 Safari/537.36",
      "os": "Windows",
      "os_version": 10,
      "lantern_version": "2.2.0 (20160413.044024)"
    }
  },
  {
    "name": "client_results",
    "ts": "2007-04-05T14:30:25.711726Z",
    "values": {
      "num_errors": 12,
      "num_successes": 89
    },
    "dimensions": {
      "client": "22DFS324DSFDSF",
      "proxy": "185.234.23.5",
      "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_11_4) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/50.0.2661.94 Safari/537.36",
      "os": "Windows",
      "os_version": 10,
      "lantern_version": "2.2.0 (20160413.044024)"
    }
  }
]
Response  201
HideShow
Headers
Content-Type: text/plain
Response  400
HideShow
Headers
Content-Type: text/plain
Body
Message will indicate what specifically was wrong
Response  405
HideShow
Headers
Content-Type: text/plain
Response  415
HideShow
Headers
Content-Type: text/plain

Generated by aglio on 22 May 2016