organisation v2

Get Overview tiles count

Gets all tile count data for overview page. Required Permissions: Organisation Members

get/v2/organisation/{orgid}/overview

Path parameters

The organisation's id

Response

The OU Overview Response

userListCountinteger required
adminCountinteger required
keyUsersCountinteger required
restrictedUsersCountinteger required
standardUsersCountinteger required
groupsCountinteger required
projectsCountinteger required
mappingsCountinteger required
pendingMetaDataCountinteger required
appKeysCountinteger required
templatesCountinteger required
archivedProjectsCountinteger required
projectUserCountinteger required
dailyDocumentDigestCountinteger required
projectBasketCountinteger required
privilegesCountinteger required

Example response

{
  "userListCount": 31,
  "adminCount": 18,
  "keyUsersCount": 3,
  "restrictedUsersCount": 0,
  "standardUsersCount": 10,
  "groupsCount": 10,
  "projectsCount": 26,
  "mappingsCount": 5,
  "pendingMetaDataCount": 85,
  "appKeysCount": 4,
  "templatesCount": 10,
  "archivedProjectsCount": 12,
  "ouStorageStats": {
    "_id": "602164446221e60038d6737e",
    "ouId": "593954c3331fc5160531987f",
    "ouType": 10,
    "parentOuId": "593954c3331fc5160531987f",
    "activeSize": 2149169676,
    "recycledSize": 261334917,
    "nodeCount": {
      "1": {
        "recycledNodes": 197,
        "activeNodes": 5546
      },
      "2": {
        "recycledNodes": 283,
        "activeNodes": 1900
      },
      "3": {
        "recycledNodes": 1,
        "activeNodes": 13
      },
      "4": {
        "recycledNodes": 8,
        "activeNodes": 27
      },
      "5": {
        "activeNodes": 2
      },
      "6": {
        "activeNodes": 1
      }
    },
    "__v": 0,
    "fullDiskSize": 2900450808,
    "fullNodeCount": {
      "1": {
        "activeNodes": 5827,
        "recycledNodes": 200
      },
      "2": {
        "activeNodes": 2350,
        "recycledNodes": 334
      },
      "3": {
        "activeNodes": 18,
        "recycledNodes": 1
      },
      "4": {
        "activeNodes": 57,
        "recycledNodes": -5
      },
      "5": {
        "activeNodes": 3,
        "recycledNodes": 0
      },
      "6": {
        "activeNodes": 1,
        "recycledNodes": 0
      }
    },
    "projects": [
      {
        "_id": "605355a8858ba742985e0fc6",
        "ouId": "605355a8858ba714055e0fc1",
        "ouType": 20,
        "parentOuId": "593954c3331fc5160531987f",
        "activeSize": 328991023,
        "recycledSize": 0,
        "nodeCount": {
          "0": {
            "activeNodes": 1
          },
          "1": {
            "recycledNodes": 0,
            "activeNodes": 2
          },
          "2": {
            "recycledNodes": 0,
            "activeNodes": 13
          },
          "3": {
            "activeNodes": 0
          },
          "4": {
            "recycledNodes": 0,
            "activeNodes": 1
          }
        },
        "__v": 0,
        "name": "Will Test Project",
        "description": "Default Project",
        "formOfContract": "None",
        "archived": true
      }
    ]
  },
  "projectUserCount": 8,
  "dailyDocumentDigestCount": 1,
  "projectBasketCount": 0,
  "privilegesCount": 0
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.