Admin: Realtime Status Endpoints

The following Realtime methods can be used to determine the current status of the RPI Realtime installation:

• GET api/Status: returns the overall status of the RPI Realtime installation. The payload is returned as follows:

  JSON

  {
    "OverallStatus": true,
    "RealtimeAgent": {
      "InProcessAgentEnabled": false,
      "ServiceStatus": {
        "Status": true,
        "Message": null
      },
      "Databases": {
        "PulseDatabase": {
          "Status": true,
          "Message": null
        },
        "LoggingDatabase": {
          "Status": true,
          "Message": null
        },
        "ClientOperationalDatabase": null,
        "DataWarehouse": null,
        "AuxDatabases": null
      },
      "ClientAvailability": null
    },
    "Caches": {
      "NonVisitorData": {
        "Status": true,
        "Message": null
      },
      "VisitorProfile": {
        "Status": true,
        "Message": null
      },
      "VisitorHistory": {
        "Status": true,
        "Message": null
      },
      "ProductRecommendations": {
        "Status": true,
        "Message": null
      },
      "VisitorBackup": null
    },
    "Queues": {
      "ClientQueues": {
        "Status": true,
        "Message": null
      },
      "ListenerQueue": {
        "Status": true,
        "Message": null
      }
    }
  }
  

• GET api/Status/{cacheName}: returns status details of a specific cache. The cacheName parameter should be set to the name of the cache as defined at the appsettings.json configuration file.  The payload returned is contingent on the cache type; for example, ‘database’ returns the SQL required to create the cache.