Get Statistics Widgets - onOffice API

Resource type: statisticWidgets

Reads the configuration of the statistics widgets from the statistics tab for properties. User right “Visible Property statistics” (Sichtbare Objektstatistiken) must not be set to “None” in order to have read access.

Parameter:

module
STRING. MANDATORY. Module. Only possible value: estate.

Example

{
    "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
    "resourceid": "",
    "identifier": "",
    "resourcetype": "statisticWidgets",
    "parameters": {
        "module":"estate"
    }
}

Response parameter:

id
INTEGER. Module. ID of the statistic widget.
title
STRING. Title of the statistic widget.
type
STRING. Type of the statistic widget.
activeForReporting
BOOLEAN. Setting “Active for the owner reporting”.
tab
STRING. Name of the statistic tab.
configuration
OBJECT. Information about the configuration of the statistics widget. Information about widgetType, evaluationTarget, evaluationType, addressFilterId and actionTypes is included.
actionAttribute
ARRAY. Action attributes of the statistics widget (Activity features).
origin
OBJECT. Origin (Source/contact) of the statistics widget with id and value.
attribute
OBJECT. Attribute (Characteristic) of the statistics widget with id and value.
period
STRING. Period of the statistic widget.
chartType
STRING. Chart type (Diagram) of the statistic widget.
showSumRow
BOOLEAN. Setting “Display total line (only in table view)”.
description
STRING. Tab remarks of the statistic widget.

Response example

{
  "status": {
    "code": 200,
    "errorcode": 0,
    "message": "OK"
  },
  "response": {
    "results": [
      {
        "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:get",
        "resourceid": "",
        "resourcetype": "statisticWidgets",
        "cacheable": true,
        "identifier": "",
        "data": {
          "meta": {
            "cntabsolute": 1
          },
          "records": [
            {
              "id": 275,
              "type": "statisticWidgets",
              "elements": {
                "id": "275",
                "title": "Overview activities",
                "type": "statisticDetailReportingActivities",
                "activeForReporting": false,
                "tab": "Allgemein",
                "configuration": {
                  "widgetType": "diagram",
                  "evaluationTarget": "targetAgentsLogCount",
                  "evaluationType": "typeAktionsart",
                  "addressFilterId": 0,
                  "actionTypes": [
                    {
                      "id": 118,
                      "type": "Termin",
                      "children": [
                        {
                          "id": "57",
                          "type": "Beratung"
                        },
                        {
                          "id": "33",
                          "type": "Besichtigung"
                        }
                      ]
                    },
                    {
                      "id": 194,
                      "type": "Immofeedback / Terminnachbereitung",
                      "children": [
                        {
                          "id": "224",
                          "type": "Rückmeldung Besichtigung"
                        },
                        {
                          "id": "277",
                          "type": "Rückmeldung Web-Exposé"
                        }
                      ]
                    },
                    {
                      "id": 120,
                      "type": "Email",
                      "children": [
                        {
                          "id": "28",
                          "type": "Eingang"
                        },
                        {
                          "id": "29",
                          "type": "Ausgang"
                        },
                        {
                          "id": "169",
                          "type": "MLS Angebot versendet"
                        }
                      ]
                    }
                  ],
                  "actionAttribute": [
                    "Download",
                    "Downloadlink",
                    "Download1",
                    "externalMail",
                    "Kontakt zugefuehrt",
                    "agreedToDataStorage",
                    "cancelationConfirmationAgreementLink",
                    "storno",
                    "Exposeversand"
                  ],
                  "origin": [],
                  "attribute": [],
                  "period": "",
                  "chartType": "bar",
                  "showSumRow": false,
                  "description": "Dieses Widget bietet eine Übersicht über die bisher getätigten Aktivitäten."
                }
              }
            }
          ]
        },
        "status": {
          "errorcode": 0,
          "message": "OK"
        }
      }
    ]
  }
}