Access API Documentation | Access Technical Support Portal | Email: support@validic.com
Validic Support Center
Click Here for Latest System Status

Getting the Total Number of Users who have Connected an App

Last Updated: Mar 27, 2019 01:04PM EDT
Q: How can we get the total number of users who have already connected at least one app/integration?

There are three options to capture the total number of your users who have already connected at least one app.

The first option is by making an {ORGANIZATION_ID}.json API Call. In the API response, you will be able to retrieve the total number of users who have already connected an app by looking at the "users" field.
GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}.json?access_token={ORGANIZATION_ACCESS_TOKEN}
Sample API Response:
{
    "summary": {
        ...
    }
    "organization": {
        "_id": "{ORGANIZATION_ID}",
        "name": "{ORGANIZATION NAME}",
        "users": {VALUE},
        "users_provisioned": {VALUE},
        "activities": {VALUE},
        "connections": {VALUE},
        "organizations": []
    }
}
The second option is by making the Users.json API Call and appending the parameter "status=active". Here, you are able to verify the Validic USER IDs or "_id" with each having a corresponding "uid" or the users' unique identification used when they were provisioned. The API response using this API Call will enable you to see the total number of active users, which by definition mean that they have already connected at least one app. You may be able to do this by making the sample API call:
GET https://api.validic.com/v1/organizations/{ORGANIZATION_ID}/users.json?access_token={ORGANIZATION_ACCESS_TOKEN}&status=active
Sample API Response:
{
    "summary": {
        "status": 200,
        "message": "Ok",
        "results": 1,
        "start_date": "2015-01-12T00:00:00+00:00",
        "end_date": "2015-01-14T23:59:59+00:00",
        "offset": 0,
        "limit": null,
        "previous": null,
        "next": null,
        "params": {
            "start_date": null,
            "end_date": null,
            "offset": 0,
            "limit": 0
        }
    },
    "users": [
        {
            "_id": "{VALIDIC USER ID}",
            "uid": "{CUSTOMER_USER_ID}"
        },
        ...
     ]
}
The third option is by making the Profile.json API Call. The Profile.json endpoint provides a listing of applications currently synced by your user, which will give you the benefit of aggregating the total number of users who have synced a particular application. To do this, you may loop through each of your users and make the following API call below:
GET https://api.validic.com/v1/profile.json?authentication_token={USER_ACCESS_TOKEN}
Sample API Response:
{
    "profile": {
        "uid": "{USER'S UNIQUE IDENTIFICATION}",
        "_id": "{VALIDIC USER ID}",
        "gender": "M",
        "location": null,
        "country": null,
        "birth_year": null,
        "height": null,
        "weight": null,
        "applications": [
            {
                "name": "fatsecret"
            },
            {
                "name": "fitbit"
            },
            {
                "name": "fleetly"
            },
            {
                "name": "healthgraph"
            },
            {
                "name": "jawbone_up"
            },
            {
                "name": "mapmyfitness"
            },
            {
                "name": "mapmyrun"
            },
            {
                "name": "mapmytri"
            },
            {
                "name": "mapmywalk"
            },
            {
                "name": "movable"
            },
            {
                "name": "nikeplus"
            },
            {
                "name": "strava"
            },
            {
                "name": "withings"
            }
        ]
    }
}
 
vlogo
bc869bd0260c3360eac041337ba489f0@validic.desk-mail.com
https://cdn.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete