Example Request/Response

In the following example, we are requesting the following properties: geography.country, ram, lifetimeEventUsage, and reachOutDeliveries.auto. We are requesting daily data for 1 - 10 January 2018, and asking for 1 property in the daily data: prodVersion. We are also filtering for 1 single client ID.

Example Request

POST /reporting/clientPropertyList  HTTP/1.1

Host: api.revulytics.com

Content-Type: application/json

Accept: application/json

{

    "user": "testuser@test.com",

    "sessionId": "VSB8E2BzSC2eZSJm4QmTpA",

    "productId": 12345678901,

    "globalFilters":

          {

              "clientId":

                  {

                      "type": "string",

                      "value": "0AC28257D3E9F271"

                  }

          },

    "properties":

          [

              "geography.country",

              "ram",

              "lifetimeEventUsage",

              "reachOutDeliveries.auto"

          ],

    "retDailyData":

          {

              "startDate": "2018-01-01",

              "stopDate": "2018-01-10",

              "properties":

                  [

                      "prodVersion"

                  ]

          }

}

Example Response

HTTP/1.1 200 OK

Content-Type: application/json

{

    "status": "OK",

    "results":

          [

              {

                  "clientId": "0AC28257D3E9F271",

                  "geography.country": "US",

                  "ram": 8192,

                  "lifetimeEventUsage":

                      [

                          {

                              "eventCategory": "File Operations",

                              "eventName": "Open",

                              "eventCount": 42

                          },

                          {

                              "eventCategory": "File Operations",

                              "eventName": "Delete",

                              "eventCount": 5

                          }

                      ],

                  "reachOutDeliveries.auto":

                      [

                          {

                              "reachoutID": 7,

                              "name": "Welcome message"

                          },

                          {

                              "reachoutID": 15,

                              "name": "Upgrade to premium"

                          }

                      ],

                  "dailyData":

                      [

                          {"date": "2018-01-03", "prodVersion": "1.1"},

                          {"date": "2018-01-04", "prodVersion": "1.1"},

                          {"date": "2018-01-08", "prodVersion": "1.1"},

                          {"date": "2018-01-10", "prodVersion": "1.4"}

                      ]

              }

          ],

    "reachedEnd": true

}