API Guide: Video Data

An overview of accessing the R1 Discover activity data via our API.

Introduction

This guide provides detailed instructions for integration partners on how to effectively access data on users watching our videos via the API endpoints. By following this guide, partners can ensure a seamless and efficient integration process, enabling them to create a comprehensive picture of user video interactions within the R1 Discover platform.

Prerequisites

Before beginning the integration process, ensure an R1 Discover Tech Partner account has been created, and you are able to generate your bearer token for authentication.

Detailed instructions on prerequisites can be found here: R1 API: Getting Started

Workflow Overview

Understanding the workflow of accessing the user video data API endpoints is crucial for efficient integration. This section outlines the order in which the endpoints should be accessed to successfully gather user video data.

Workflow Diagram:

1. Generate Bearer Token

2. Retrieve Core Company Data

   • Company List

   • Company User List

   • Company Topic List

   • Company Activity List

3. Access Video Data

   • View Company Video Metrics

   • View User Video Metrics

Step-by-Step Instructions

Generate Bearer Token

Instructions:

1. Log into R1 Discover Tech Partner Account.

2. Select the My Companies tab.

3. Click the Key icon to generate a token.

4. Copy the token to a secure location. Note that the token will no longer be visible once you leave the page.

Link to Documentation: Generate Bearer Token

Retrieve Company List

Instructions:

1. Use the Company List Endpoint to retrieve the list of companies and their IDs.

2. Make a GET request to https://api.r1learning.com/api/v1/company-list/{page}/{limit}.

3. Include the Bearer token in the request headers.

Link to Documentation: Company List Endpoint

Retrieve Company Topic List

Instructions:

1. Use the Company Topic List Endpoint to retrieve the list of all topics available to a company.

2. Make a GET request to https://api.r1learning.com/api/v1/company-topic-list.

3. Include the Bearer token in the request headers.

Link to Documentation: Company Topic List Endpoint

Retrieve Company Activity List

Instructions:

1. Use the Company Activity List Endpoint to retrieve the list of all activities available to a company.

2. Make a GET request to https://api.r1learning.com/api/v1/company-activity-list.

3. Include the Bearer token in the request headers.

Link to Documentation: Company Activity List Endpoint

View Company Video Metrics

Instructions:

1. Use the View Company Video Metrics Endpoint to retrieve the list of all video sessions for all users in the company.

2. Make a GET request to https://api.r1learning.com/api/v1/view-company-video-metrics/{companyId}/{page}/{limit}.

3. Include the Bearer token in the request headers.

Link to Documentation: View Company Video Metrics Endpoint

View User Video Metrics

Instructions:

1. Use the View User Video Metrics Endpoint to retrieve the list of all video sessions for a specific user in the company.

2. Make a GET request to https://api.r1learning.com/api/v1/view-user-video-metrics/{userId}/{page}/{limit}.

3. Include the Bearer token in the request headers.

Link to Documentation: View User Video Metrics Endpoint