[Feature Request] Cleanuparr Service Widget

[Ykrej]

Description

Cleanuparr is a companion service to the *arr stack and has an api that exposes statistics. I would like to see a service widget added for Cleanuparr to display some stats from the api I mentioned.

I am not sure what stats would be worth showing.

Other

Example response from stats api.

{
  "events": {
    "totalCount": 0,
    "byType": {},
    "bySeverity": {},
    "timeframeHours": 24
  },
  "strikes": {
    "totalCount": 0,
    "byType": {},
    "itemsRemoved": 0,
    "timeframeHours": 24
  },
  "jobs": {
    "byType": {
      "CustomFormatScoreSyncer": {
        "totalRuns": 4,
        "completed": 4,
        "failed": 0,
        "lastRunAt": "1970-01-01T00:00:00.0000000Z",
        "nextRunAt": "1970-01-01T00:00:00Z"
      },
      "QueueCleaner": {
        "totalRuns": 23,
        "completed": 23,
        "failed": 0,
        "lastRunAt": "1970-01-01T00:00:00.0000000Z",
        "nextRunAt": "1970-01-01T00:00:00Z"
      },
      "Seeker": {
        "totalRuns": 6,
        "completed": 6,
        "failed": 0,
        "lastRunAt": "1970-01-01T00:00:00.0000000Z",
        "nextRunAt": "1970-01-01T00:00:00Z"
      },
      "MalwareBlocker": {
        "totalRuns": 0,
        "completed": 0,
        "failed": 0,
        "lastRunAt": null,
        "nextRunAt": null
      },
      "DownloadCleaner": {
        "totalRuns": 0,
        "completed": 0,
        "failed": 0,
        "lastRunAt": null,
        "nextRunAt": null
      },
      "BlacklistSynchronizer": {
        "totalRuns": 0,
        "completed": 0,
        "failed": 0,
        "lastRunAt": null,
        "nextRunAt": null
      }
    },
    "timeframeHours": 24
  },
  "health": {
    "downloadClients": [
      {
        "id": "11111111-1111-1111-1111-111111111111",
        "name": "QBittorrent",
        "type": "qBittorrent",
        "isHealthy": true,
        "lastChecked": "1970-01-01T00:00:00.0000000Z",
        "responseTimeMs": 1004.6103,
        "errorMessage": null
      }
    ],
    "arrInstances": [
      {
        "id": "22222222-2222-2222-2222-222222222222",
        "name": "Sonarr",
        "type": "Sonarr",
        "isHealthy": true,
        "lastChecked": "1970-01-01T00:00:00.0000000Z",
        "errorMessage": null
      },
      {
        "id": "33333333-3333-3333-3333-333333333333",
        "name": "Radarr",
        "type": "Radarr",
        "isHealthy": true,
        "lastChecked": "1970-01-01T00:00:00.0000000Z",
        "errorMessage": null
      }
    ]
  },
  "generatedAt": "1970-01-01T00:00:00.0000000Z"
}

[UncleNet41]

Since you haven't got a response yet: even if it's not implemented as a standalone widget, you can make it work with the customapi widget.

For example:

   - Cleanuparr:
       icon: cleanuparr.png
       href: http://192.168.1.xxx:11011
       widget:
          type: customapi
          url: http://192.168.1.xxx:11011/api/stats
          refreshInterval: 10000
          method: GET
          headers:
            X-Api-Key: your-api-key-from-cleanuparr
          mappings:
            - field: jobs.byType.MalwareBlocker.totalRuns
              label: MALWARE BLOCKER
            - field: jobs.byType.QueueCleaner.totalRuns
              label: QUEUE CLEANER
            - field: jobs.byType.Seeker.totalRuns
              label: SEEKER

which produces

you can easily adjust values if you want, just change the mappings with the corresponding entitities in the API.

if you have disabled the login for the local addresses in the Cleanuparr settings, you can skip the headers and X-Api-Key values entirely.