Product SiteDocumentation Site

Chapter 1. Full Application Programming Interface

1.1. Introduction
1.2. Authentication
1.3. JSON Params
1.4. Dimensions for rb_flow
1.5. Dimensions for rb_event
1.6. Dimensions for rb_monitor
1.7. Dimensions for rb_social
1.8. Dimensions for rb_state
1.9. Filters
1.10. Examples: rb_flow
1.11. Examples: rb_event

1.1. Introduction

The Full Api use a HTTP REST style via https web interface. The query must be expresed in JSON format to specify which values is asking for. For example
{
    "dataSource": "rb_flow",
    "granularity": "all",
    "namespace_uuids": ["2584761509592299795"],
    "intervals":["2013-11-21T19:07/2013-11-21T19:30"],
    "queryType": "groupBy",
    "aggregations": [
        {"type": "longSum", "name": "events", "fieldName": "events"}
    ],
    "dimensions": [
        "http_host",
        "src",
        "http_user_agent"
    ],
    "filter": {
        "type": "and",
        "fields": 
        [ 
          {
            "type": "selector",
            "dimension": "client_mac",
            "value": "8c:58:77:0b:56:fc"
          }, {
            "type": "regex",
            "dimension": "src",
            "pattern": "^10\\.13\\."
          }
        ] 
    }
}
This query will return something like:
[
  {
    "version":"v1",
    "timestamp":"2013-11-21T19:07:00.000Z",
    "event":{
      "count":198,
      "http_user_agent":null,
      "http_host":null,
      "src":"10.13.209.147"
    }
  },
  {
    "version":"v1",
    "timestamp":"2013-11-21T19:07:00.000Z",
    "event":{
      "count":1,
      "http_user_agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Mobile/11B511 [FBAN/FBIOS;FBAV/6.7;FBBV/566055;FBDV/iPhone3,3;FBMD/iPhone;FBSN/iPhone OS;FBSV/7.0.3;FBSS/2; FBCR/Verizon;FBID/phone;FBLC/en_US;FBOP/5]",
      "http_host":"ajax.googleapis.com",
      "src":"10.13.209.147"
    }
  },
  {
    "version":"v1",
    "timestamp":"2013-11-21T19:07:00.000Z",
    "event": {
      "count":1,
      "http_user_agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Mobile/11B511 [FBAN/FBIOS;FBAV/6.7;FBBV/566055;FBDV/iPhone3,3;FBMD/iPhone;FBSN/iPhone OS;FBSV/7.0.3;FBSS/2; FBCR/Verizon;FBID/phone;FBLC/en_US;FBOP/5]",
      "http_host":"busymockingbird.files.wordpress.com",
      "src":"10.13.209.147"
    }
  },
  {
    "version":"v1",
    "timestamp":"2013-11-21T19:07:00.000Z",
    "event":{
      "count":1,
      "http_user_agent":"Mozilla/5.0 (iPhone; CPU iPhone OS 7_0_3 like Mac OS X) AppleWebKit/537.51.1 (KHTML, like Gecko) Mobile/11B511 [FBAN/FBIOS;FBAV/6.7;FBBV/566055;FBDV/iPhone3,3;FBMD/iPhone;FBSN/iPhone OS;FBSV/7.0.3;FBSS/2; FBCR/Verizon;FBID/phone;FBLC/en_US;FBOP/5]",
      "http_host":"connect.facebook.net",
      "src":"10.13.209.147"
    }
  }
]

NOTE:

The result has been truncated