Organization Overview

Mar 4, 2015

Organization Summary Overview

Example

To retrieve a summary overview of an Organization and its Child Organizations make the following call:

GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}.json?access_token={ORGANIZATION_ACCESS_TOKEN} 
GET https://api.validic.com/v1/organizations/516828cf6deddabe51000001.json?access_token=e61467e3845e8a66f7453dc55ea3fc445d1b879a6f96ebe7b243badbeae04f63
200
{
  "summary": {
    ...
  },
  "organizations": {
    "_id": "516828cf6deddabe51000001",
    "name": "Sample Organization",
    "users": 25442,
    "users_provisioned": 83211,
    "activities": 453298,
    "connections": 38749,
    "organizations": [
      {
        "_id": "516828df6deddabe51000004",
        "name": "Child Org 1",
        "users": 11892,
        "users_provisioned": 31923,
        "activities": 212783,
        "connections": 17453,
        "organizations": []
      },
      {
        "_id": "516828df6deddabe51000008",
        "name": "Child Org 2",
        "users": 11529,
        "users_provisioned": 48384,
        "activities": 240515,
        "connections": 21296,
        "organizations": []
      }
    ]
  }
}

Organization Overview Params

Field
Type
Description
name
String
The name of the Organization. Used primarily for internal identification rather than public display.
users
Integer
The number of users under an Organization with one or more apps connected. This number is aggregate for an Organization and its Child Organizations.
users_provisioned
Integer
The total number of users with a provisioned Validic account (including those without one or more apps connected). This number is aggregate for an Organization and its Child Organizations.
activities
Integer
A running total of all activities logged under an Organization. This number is aggregate for an Organization and its Child Organizations.
connections
Integer
The number of live connections between an Organization’s users and their apps. This number is aggregate for an Organization and its Child Organizations.

View More >