User Reports API

For Authentication API go here: https://support.saleshood.com/knowledge-base/api-authentication/

Overview

This document describes SalesHood’s APIs that return information about users and their activities. All API requests require an access_token which can be acquired via the API Authentication process.

User Personnel Data

Retrieve users’ personnel data such as email, manager, segment, etc. Returned data includes active and inactive users.

Request

Endpoint: /reports/user/personnel_data.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes

Example:

GET /reports/user/personnel_data.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K HTTP/1.1
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

Example:

{
    "params": {

    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "fullName": "John Doe",
                "email": "john.doe@gmail.com",
                "role": "Productivity Coach",                 
                "manager": "John Doe Sr",                     // null (no manager)
                "managerEmail": "john.doe.sr@gmail.com",      // null (no manager)
                "segment": "Enterprise Sales",                // null (no manager)
                "active": true
            },
            { /* another user */ },
            // more users 
        ]
    }
}

Request

Endpoint: /api/v1/reports/personnel_data.json

Response

{
    "params": {

    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "fullName": "John Doe",
                "email": "john.doe@gmail.com",
                "role": "Productivity Coach",                 
                "manager": "John Doe Sr",                     // null (no manager)
                "managerEmail": "john.doe.sr@gmail.com",      // null (no manager)
                "segment": "Enterprise Sales",                // null (no manager)
                "active": true,
                "group": ["Group Name"],                      // empty (no group)
            },
            { /* another user */ },
            // more users 
        ]
    }
}

User Activities

Retrieve users’ activities such as activity count, video watching time, etc. Returned data only includes active users.

Request

Endpoint: /reports/user/activities.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes
from_datedate on or before when activities are made (MM/DD/YYYY)yes
to_datedate after when activities are made (MM/DD/YYYY)yes

Example:

GET /reports/user/activities.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K&from_date=01/01/2016&to_date=04/01/2017
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

Example:

{
    "params": {
        "fromDate": "01/01/2016",      
        "toDate": "04/01/2017"         
    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "totalActivities": 0,
                "totalVideoWatchingTime": 0,
                "totalDealWinsUploaded": 0,
                "totalDealWinsWatched": 0
            },
            { /* another user */ },
            // more users 
        ]
    }
}

User Participation In Learning Paths

Retrieve users who have participated in learning paths. Returned data only includes active users.

Return all users whose participation date falls within the from_date and to_date range. Participation date is the date the user was added to the learning path.

Request

Endpoint: /reports/user/learning_paths.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes
from_dateMM/DD/YYYYyes
to_dateMM/DD/YYYYyes

Example:

GET /reports/user/learning_paths.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K&from_date=01/01/2016&to_date=04/01/2017
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

{
    "params": {
        "fromDate": "01/01/2016",      
        "toDate": "04/01/2017"         
    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "learningPaths": [
                    {
                        "type": "Learning Path",
                        "name": "SKO Onboarding",
                        "category": "onboarding",
                        "prepTimeDuration": 100,             
                        "host": "John Doe",
                        "id": 10,
                        "completion": 0,                
                        "startDate": "03/05/2017"              // null (LP has no start date)
                    },
                    { /* more learning paths */ }
                ]
            },
            { /* another user */ },
            // more users 
        ]
    }
}

Example:

User Participation In Contents

Retrieve users who have participated in contents. Returned data only includes active users.

Return all users whose participation date falls within the from_date and to_date range.

Request

Endpoint: /reports/user/contents.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes
from_dateMM/DD/YYYYyes
to_dateMM/DD/YYYYyes

Example:

GET /reports/user/contents.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K&from_date=01/01/2016&to_date=04/01/2017
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

Example:

{
    "params": {
        "fromDate": "01/01/2016",      
        "toDate": "04/01/2017"         
    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "contents": [                                  
                    {
                        "type": "Open Content",                 // [ "Scheduled Content", "Learning Path Content" ]
                        "name": "SKO Huddle",                  
                        "category": "Compelling Events",      
                        "prepTimeDuration": 100,
                        "host": "John Doe",                     // null (open content)
                        "id": 100,
                        "scheduledDate": "03/05/2017",          // null (open content, or self-paced learning path content)
                        "completion": 0,
                        "totalExerciseSubmissions": 0,
                        "totalContentCommentsGiven": 100,
                        "testScore": [                          // null (no test module)
                            {
                                "test_name": "test 1",
                                "score": 100
                            },
                            { /* other test modules  */ }
                        ],
                        "videoCompletion": 100                  // null (no video module)
                    },
                    { /* more contents */ }
                ]
            },
            { /* another user */ },
            // more users 
        ]
    }
}

User Participation In Pitches

Retrieve users who have participated in pitches. Returned data only includes active users.

Return all users whose participation date falls within the from_date and to_date range.

Request

Endpoint: /reports/user/certifications.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes
from_dateMM/DD/YYYYyes
to_dateMM/DD/YYYYyes

Example:

GET /reports/user/certifications.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K&from_date=01/01/2016&to_date=04/01/2017
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

Example:

{
    "params": {
        "fromDate": "01/01/2016",      
        "toDate": "04/01/2017"         
    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "certifications": [
                    {
                        "type": "Open Certification",          // [ "Scheduled Certification", "Learning Path Certification" ]
                        "name": "SKO Pitch",                   
                        "category": "Compelling Events",
                        "prepTimeDuration": 100,
                        "host": "John Doe",                    // null (open certification)
                        "id": 1000,
                        "startDate": "03/05/2017",             // null (open certification, or self-paced learning path certification)
                        "uploadByDate": "03/05/2017",          // null (open certification, or self-paced learning path certification)
                        "peerReviewDate": "03/05/2017",        // null (open certification, or self-paced learning path certification)
                        "certificationId": 1234,               // null (not yet uploaded certification)
                        "score": 0,                            // null (not yet scored or certification has no score)
                        "reviewsReceived": 0,
                        "reviewsGiven": 0,
                        "viewsOfOtherCertifications": 0
                    },
                    { /* more certifications */ }
                ]
            },
            { /* another user */ },
            // more users 
        ]
    }
}

User Participation In External Events

Retrieve users who have participated in external events. Returned data only includes active users.

Return all users whose participation date falls within the from_date and to_date range.

Request

Endpoint: /reports/user/external_events.json

ParameterValueRequired
access_tokenvalid access token obtained from access token request or refresh requestyes
from_dateMM/DD/YYYYyes
to_dateMM/DD/YYYYyes

Example:

GET /reports/user/external_events.json?access_token=92sNkPsXlWlF0j1sGhthmTR0TYy26K&from_date=01/01/2016&to_date=04/01/2017
Host: secure.saleshood.com

Content-Type: application/x-www-form-urlencoded

Response

Example:

{
    "params": {
        "fromDate": "01/01/2016",      
        "toDate": "04/01/2017"         
    },
    "data": {
        "users": [
            {
                "saleshoodUserId": 1234,
                "externalEvents": [
                    {
                        "type": "Learning Path External Event",
                        "name": "Accessing Tools",
                        "category": "Compelling Events",
                        "host": "John Doe",
                        "link": "https://www.google.com",
                        "completion": 100,                     
                    },
                    { /* more external events */ }
                ]
            },
            { /* another user */ },
            // more users 
        ]
    }
}

Was this article helpful?

Leave A Comment?

You must be logged in to post a comment.