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 program and user status. All API requests require an access_token which can be acquired via the API Authentication process.

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: /api/v1/reports/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 /api/v1/reports/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": [
      {
        "id": 1,
        "name": "Learning path name",
        "overallCompletion": "No",
        "completion": 8,
        "createDate": "03/25/2015",
        "updateDate": "09/22/2016",
        "dueDate": "09/19/2016",
        "numberOfParticipant": 3,
        "participants": [
            {
                "participant_id": 11,
                "overall_completion": "No",
                "completion": 6
            },
            {
                "participant_id": 22,
                "overall_completion": "Yes",
                "completion": 100
            },
            {
                "participant_id": 33,
                "overall_completion": "No",
                "completion": 0
            }
        ]
      },
      { /* more learning paths */ }
    ]
}

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: /api/v1/reports/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 /api/v1/reports/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": [
      {
        "id": 25031,
        "name": "Huddle Event name",
        "overallCompletion": "No",
        "completion": 3,
        "createDate": "03/30/2015",
        "updateDate": "04/11/2018",
        "dueDate": "03/30/2015",
        "numberOfParticipant": 3,
        "participants": [
            {
                "participant_id": 11,
                "overall_completion": "No",
                "completion": 0
            },
            {
                "participant_id": 22,
                "overall_completion": "No",
                "completion": 17
            },
            {
                "participant_id": 33,
                "overall_completion": "Yes",
                "completion": 100
            }
        ]
      },
      { /* more contents */ }
    ]
}

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: /api/v1/reports/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 /api/v1/reports/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": [
      {
        "id": 11,
        "name": "Certification name",
        "overallCompletion": "No",
        "completion": 75,
        "createDate": "12/09/2013",
        "updateDate": "03/16/2016",
        "numberOfParticipant": 4,
        "participants": [
            {
                "participant_id": 11,
                "overall_completion": "Yes",
                "completion": 100
            },
            {
                "participant_id": 22,
                "overall_completion": "No",
                "completion": 0
            },
            {
                "participant_id": 33,
                "overall_completion": "Yes",
                "completion": 100
            },
            {
                "participant_id": 44,
                "overall_completion": "Yes",
                "completion": 100
            }
        ]
      },
      { /* more certifications */ }
    ]
}

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: /api/v1/reports/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 /api/v1/reports/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": [
      {
        "id": 11,
        "name": "External event name",
        "overallCompletion": "No",
        "completion": 0,
        "createDate": "04/27/2016",
        "updateDate": "04/27/2016",
        "numberOfParticipant": 4,
        "participants": [
            {
                "participant_id": 11,
                "overall_completion": "No",
                "completion": 0
            },
            {
                "participant_id": 22,
                "overall_completion": "No",
                "completion": 0
            },
            {
                "participant_id": 33,
                "overall_completion": "No",
                "completion": 0
            },
            {
                "participant_id": 44,
                "overall_completion": "No",
                "completion": 0
            }
        ]
      },
      { /* more certifications */ }
    ]
}

Was this article helpful?

Leave A Comment?

You must be logged in to post a comment.