Skip to content

Generic Date Range Reports

Request

This reporting mechanism is to be used for generating reports regarding user activity within a particular specified date range. Depending on the request, this can create timeline charts, pie/bar charts, geographical maps, or hierarchical tables.

Path
product_idstringrequired
Headers
Content-Typestring
Example:application/json
RUI-Clientstring
Example:Postman
RUI-Client-Versionstring
Example:0.0.1
Originstring
Example:https://analytics.revenera.com
Bodyapplication/json
object
curl -i -X POST \
  'https://developer.revenera.com/_mock/products/rui/apis/v3_api_redocly/v3/reporting/generic/dateRange/{product_id}' \
  -H 'Content-Type: application/json' \
  -H 'Origin: https://analytics.revenera.com' \
  -H 'RUI-Client: Postman' \
  -H 'RUI-Client-Version: 0.0.1' \
  -d '{
    "clientStatus": [
      "new",
      "active",
      "lost"
    ],
    "startDate": "2023-05-15",
    "stopDate": "2023-07-13",
    "groupBy": "clientId",
    "daysUntilDeclaredLost": 40,
    "dateReportedLost": "dateDeclaredLost",
    "dateSplit": "week",
    "globalFilters": {
      "os": {
        "platform": {
          "value": [
            "Microsoft Windows"
          ]
        },
        "version": {
          "value": [
            "Microsoft Windows Server 2003"
          ]
        },
        "edition": {
          "value": [
            "Microsoft Windows 10 Home",
            "Microsoft Windows 10 Generic"
          ]
        },
        "type": "stringArray"
      },
      "geography": {
        "continent": {
          "value": [
            "AS",
            "EU"
          ]
        },
        "country": {
          "value": [
            "DZ",
            "BE",
            "AU"
          ]
        },
        "usState": {
          "value": [
            "US-LA",
            "US-IL",
            "US-FL"
          ]
        },
        "type": "stringArray"
      },
      "gpu": {
        "vendor": {
          "value": [
            "ATI",
            "AMD",
            "Intel",
            "NVIDIA"
          ]
        },
        "model": {
          "value": [
            "AMD Radeon HD 4600",
            "AMD Radeon HD 7000",
            "AMD Radeon R7 200"
          ]
        },
        "type": "stringArray"
      },
      "optOut": [
        {
          "historical": true,
          "current": true
        }
      ],
      "backOff": [
        {
          "historical": true,
          "current": true
        }
      ],
      "lifetimeEventUsage": [
        {
          "combiArray": [
            {
              "category": "File Operations",
              "categoryType": "string",
              "nameType": "regex",
              "name": ".*"
            },
            {
              "category": "File Operations",
              "name": "Copy",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Clone",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Open",
              "categoryType": "string",
              "nameType": "string"
            },
            {
              "category": "File Operations",
              "name": "Save",
              "categoryType": "string",
              "nameType": "string"
            }
          ],
          "max": 10000
        }
      ],
      "reachOutDeliveries": [
        {
          "auto": {
            "delivered": [
              "2"
            ],
            "undelivered": [
              "3"
            ]
          },
          "manual": {
            "delivered": [
              "1"
            ]
          }
        }
      ]
    },
    "resultMode": "absolute",
    "levels": {
      "level1": {
        "property": "prodVersion",
        "segments": [
          {
            "segmentLabel": "1.5-0",
            "type": "string",
            "value": "1.5"
          }
        ]
      }
    }
  }'

Responses

OK

Headers
Serverstring
Example:"nginx/1.20.1"
Datestring
Example:"Thu, 13 Jul 2023 09:29:17 GMT"
Content-Typestring
Example:"application/json"
Content-Lengthinteger
Example:"780"
Connectionstring
Example:"keep-alive"
Access-Control-Allow-Originstring
Example:"https://analytics.revenera.com"
Access-Control-Allow-Credentialsboolean
Example:"true"
Varystring
Example:"Origin"
Rui-Apistring
Example:"RUI Reporting API (3.0.0.dev9)"
Rui-Libstring
Example:"3.0.0.dev26"
X-XSS-Protectionstring
Example:"1; mode=block"
X-Content-Type-Optionsstring
Example:"nosniff"
Referrer-Policystring
Example:"no-referrer-when-downgrade"
Bodyapplication/json
object
Response
{
  "result": {
    "2023-05-15": { … },
    "2023-05-22": { … },
    "2023-05-29": { … },
    "2023-06-05": { … },
    "2023-06-12": { … },
    "2023-06-19": { … },
    "2023-06-26": { … },
    "2023-07-03": { … },
    "2023-07-10": { … }
  }
}