This article will go over the different data sets, and the fields within them, available through our Reporting API.

To learn more about our Reporting API click here.

Data Sets Available:

• ERD
• Retrieving each dataset via the API
  • Authentication
  • Using the API to Retrieve Datasets
• buyer_sites
• buyer_site_content
• deal_review_fact (deprecated)
• external_event
• file_bookmark_map
• file_download_fact
• file_material
• file_tag_map
• file_view_fact
• group_event
• group_member
• group
• group_watcher
• huddle_event
• huddle_event_learning_path
• huddle_event_participation_fact
• huddle_scheduling_fact
• learning_path
• learning_path_participant
• learning_path_participation_fact
• path_info
• pitch
• pitch_module
• pitch_module_fact
• pitch_module_review_fact
• pitch_participation_fact
• pitch_review_fact
• pitch_scheduling_fact
• story_upload_fact
• tag
• test_result_fact
• test
• user_activity_fact
• user_session
• user
• video_watching_fact
• badge
• user_badge
• live_event
• live_event_attendees
• badge_criteria
• pitch_submission_view
• huddle_event_learning_path_file

ERD

Retrieving each dataset via the API

Authentication

You must authenticate the API with the bearer token generated from your client_id and client_secret. How to Create a Unique Token for Access to SalesHood Reporting APIs – SalesHood Support

Using the API to Retrieve Datasets

The API URL used to call each dataset will be:PRODUCTION: https://api.saleshood.com/api/v1/get_datasets?type={dataset_name} PREVIEW: https://api.preview.saleshood.com/api/v1/get_datasets?type={dataset_name}

In the ?type=  URL parameter, input the name of the dataset (see below).

buyer_sites

Information about each site that has been created in Buyer Site. Each record represents one Buyer Site.

buyer_site_content

Information on the assets that have been shared to a buyer site. Each Each record represents one asset on one site.

deal_review_fact (deprecated)

Information on reviews left on Deal Win exercise question types. The Deal Win exercise question type has been deprecated, so this dataset should be empty. Must be used with a dataset that includes the user name column, and joined by the reviewer coach column (user ID)

external_event

Information on external events in Learning Paths. Must be used with a dataset that includes the Learning Path name column, and joined by the Path ID. Must be used with a dataset that includes the user name column, and joined by the host ID (user ID)

file_bookmark_map

Information on bookmarks set on files by users. Must be used with a dataset that includes the user name column, and joined by the user ID. Must be used with a dataset that includes the file name column, and joined by the file ID.

file_download_fact

Information on download actions made by users on files. Must be used with a dataset that includes the file name column. Relationships with other file datasets are made with the file id column.

file_material

Information on files in SalesHood. Includes the file name column for use with other file datasets.

file_tag_map

Information on tags set by users on files. Must be used with a dataset that includes a file name column. Relationships with other file datasets are made with the file id column.

file_view_fact

Information on file views. Must be used with a dataset that includes a file name column. Relationships with other file datasets are made with the file id column.

group_event

Information on Learning Paths that have been assigned to Groups. Must be used with a dataset that includes learning path name and joined by learning path id. Must be used with a dataset that includes group name and joined by group id.

group_member

Information on users that are assigned to different groups. Must be used with a dataset that includes group name and joined by group id. Must be used with a dataset that includes user name and joined by user id (or id).

group

Information on Groups. This dataset includes group name (name).

group_watcher

Information on users that are Watchers of Groups. Must be used with a dataset that includes group name and joined by group_id. Must be used with a dataset that includes user name and joined by user id.

huddle_event

Information on all Huddles. Includes the huddle_name attribute.

huddle_event_learning_path

Information on Huddles in Learning Paths. Must be used with a dataset that includes huddle name and learning path name and joined by their respective id’s.

huddle_event_participation_fact

Information on participation in Huddles. Must be used with a dataset that includes huddle name and user name, and be joined by their user id and huddle id.

huddle_scheduling_fact

Information on Huddle Events that have been Scheduled. Must be used with a dataset that includes huddle_name and be joined by their huddle id.

learning_path

Information on Learning Paths. This dataset includes the Path name column that can be used to pull the name field into other datasets by relating this dataset using its ID column.

learning_path_participant

Available for dynamic learning path. Used to record the start date and due date of dynamic path

user_id learning_path_id company_id start_date due_date

learning_path_participation_fact

Information on the participation of your users that are assigned to a Learning Path. Must be used with a dataset that includes the Path name column, joined by the Path ID. Must be used with a dataset that includes the user name column, and joined by user ID.

path_info

Information on Learning Paths. This dataset includes the Path name column that can be used to pull the name field into other datasets by relating this dataset using its ID column.

pitch

Information on OLD standalone pitches (not pitches that are part of modules, created since March 2019). Includes the pitch name column, which can be used with other old standalone pitch datasets and joined by the ID of the standalone pitch.

pitch_module

Information on pitch modules that are within Huddles. Does not include old (pre-March 2019) standalone pitch information. Includes the pitch module name column which canbe used with other new pitch module datasets and joined by the ID of the Huddle event it exists in, or by the pitch module id.

pitch_module_fact

Participation information on Pitch Modules. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes the huddle name, and/or pitch name column, and joined by the pitch or Huddle ID.

pitch_module_review_fact

Review information on Pitch modules. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes the huddle name, and/or pitch name column, and joined by the pitch or Huddle ID.

pitch_participation_fact

Participation information on OLD Standalone Pitches. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes the pitch name column, and joined by the pitch ID. This dataset includes OLD standalone pitch data only (not pitch modules created post-March 2019)

pitch_review_fact

Review information on OLD Standalone Pitches. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes the pitch name column, and joined by the pitch ID. This dataset includes OLD standalone pitch data only (not pitch modules created post-March 2019)

pitch_scheduling_fact

Scheduling information on OLD Standalone Pitches. Must be used with a dataset that includes the user name column, joined by the user ID (reviewer_coach). Must be used with a dataset that includes the pitch name column, and joined by the pitch ID. This dataset includes OLD standalone pitch data only (not pitch modules created post-March 2019)

story_upload_fact

Information on all Stories uploaded to your instance. Must be used with a dataset that includes the user name column, joined by the user ID.

tag

Information on all Tags in SalesHood.

test_result_fact

Information on Test module participation. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes Learning Path or Huddle name, joined by Path or Huddle ID.

test

Information on Tests in SalesHood. This dataset includes the test name column.

user_activity_fact

Information on all activities by users in Huddle Events. Must be used with a dataset that includes the Huddle name column, and joined by the Huddle ID. Must be used with a dataset that includes the user name column, joined by the user ID.

user_session

Information on user participation by Session (Week) of a Learning Path. Must be used with a dataset that includes the user name column, joined by the user ID. Must be used with a dataset that includes the Learning Path name and joined by the Path ID.

user

User directory information of all users in your instance. This dataset includes the user name column.

video_watching_fact

User records containing number of minutes of video watched. Must be used with a dataset that includes the user name column, joined by the user ID.

badge

Badge dataset including all of active or inactive badge inside instance.

user_badge

This dataset is a bridge for mapping awarded badge with users.

live_event

live_event_attendees

badge_criteria

pitch_submission_view

huddle_event_learning_path_file