All Companies Taken Activity List

An overview of the All Companies Taken Activity List endpoint.

Endpoint Description

This endpoint retrieves details about activities such as topic & activity name, status, and timestamps for all activities across all companies that the requester can access. It is essential for overseeing user engagement and activity completion across the organization.

HTTP Method

GET /api/v1/all-companies-taken-activity-list/{page}/{limit}/{maxDays?}

Headers

• Content-Type: application/json - Specifies that the request body format is JSON.

• Accept: application/json - Indicates that the client expects a JSON response.

• Authorization: Bearer {token} - A valid Bearer token must be provided to authenticate the request.

URL Parameters

• page (integer): The current page number. Example: 1

• limit (integer): The number of records to retrieve per page. Example: 50

• maxDays (integer, optional): The maximum number of days for which records should be retrieved. Example: 10

Data Dictionary for Response Fields

The response for the "All Companies Taken Activity List" endpoint contains detailed information about each activity taken by users across all accessible companies. Below is a breakdown of each field in the response data:

• id (integer): The unique identifier for the user activity (commonly referred to as user_activity_id).

• user_id (integer): The unique identifier for the user.

• company_id (integer): The unique identifier for the company.

• activity_id (string): The unique ID of the activity on R1 Discover (Ties to Company Activity List ID).

• created_at (string): Timestamp indicating when the activity was created (formatted as a date-time).

• updated_at (string): Timestamp indicating when the activity was last updated (formatted as a date-time).

• completed_status (string): The current status of the activity. Possible values:

  • Activity Started: The activity was started, but card activity wasn’t completed. No Card/question data available.

  • Cards Completed: The card portion of activity was completed. No question data is available.

  • Activity Completed: The activity was completed. Card & Question data are available.

• completed_date (string): Timestamp indicating when the activity was completed (formatted as a date-time).

• report_url (string): URL link leading to the activity report.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/all-companies-taken-activity-list/1/50/10" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "Authorization: Bearer {token}"

JavaScript

const url = new URL(
    "https://api.r1learning.com/api/v1/all-companies-taken-activity-list/1/50/10"
);

const headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
    "Authorization": "Bearer {token}",
};

fetch(url, {
    method: "GET",
    headers,
}).then(response => response.json());

C# - Http

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.r1learning.com/api/v1/all-companies-taken-activity-list/1/50/10");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer ••••••");
var content = new StringContent(string.Empty);
content.Headers.ContentType = new MediaTypeHeaderValue("application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Response Examples

200: OK

{
  "error": 0,
  "message": "",
  "page": 1,
  "limit": 50,
  "maxDays": 10,
  "data": {
    "user_activity_list": [
      {
        "id": 1170,
        "user_id": 1178,
        "activity_id": 1,
        "company_id": 1,
        "completed_status": "Activity Completed",
        "completed_date": "2022-05-18 10:27:06",
        "created_at": "2022-05-18T14:23:53.000000Z",
        "updated_at": "2022-08-25T19:06:34.000000Z",
        "report_url": "https://discover.r1learning.com/stages-of-change/identify-my-stage-of-change/report/1170"
      }
    ]
  }
}

401: Unauthorized

{
  "message": "Unauthentiated"
}

Notes

• Authorization Required: Ensure the provided Bearer token is valid and has sufficient privileges to access the activity list.

• Response Handling: Paginate responses to manage data effectively, especially when dealing with large datasets.