View Company Taken Activity Cards

An overview of the View Company Taken Activity Cards endpoint.

Endpoint Description

The View Company Taken Activity Cards endpoint gathers comprehensive card interaction data for all users within a company.

HTTP Method

GET /api/v1/view-company-taken-activity-cards/{companyId}/{page}/{limit}/{maxDays?}

Headers

• Content-Type: application/json

• Accept: application/json

• Authorization: Bearer {token}

URL Parameters

• companyId (integer): The unique identifier of the company. This parameter is required to specify the company whose activity data is being queried.

• page (integer): The current page number in the pagination sequence. This parameter helps in retrieving a specific set of results.

• limit (integer): The number of records to retrieve per page. This parameter helps in controlling the volume of data returned.

• maxDays (integer, optional): The maximum number of days to look back from the current date to get records updated within this time frame.

Data Dictionary for Response Fields

The response for the "View User Taken Activity Cards" endpoint includes detailed information about each card associated with the user’s activities. Below is a breakdown of each field in the response data:

• user_activity_id (integer): Unique identifier for the user activity.

• company_id (integer): Unique identifier for the company.

• cards (array): Array of cards associated with the user activity.

  • card_id (integer): Unique identifier for a card, indicative of its order.

  • model_category (string): The model category of the card.

  • card_detail (string): The detailed content displayed on the card.

Request Examples

Bash

curl --request GET \
    --get "https://api.r1learning.com/api/v1/view-company-taken-activity-cards/1/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/view-company-taken-activity-cards/1/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/view-company-taken-activity-cards/1/1/50/10");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer {token}");
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": "",
  "companyId": 1,
  "page": 1,
  "limit": 50,
  "data": {
    "user_activity_id": 6652,
    "company_id": 1,
    "cards": [
      {
        "pyramid_id": 1,
        "model_category": "Contemplation",
        "card_detail": "I often think I should start this behavior"
      },
      {
        "pyramid_id": 2,
        "model_category": "Preparation",
        "card_detail": "I have recently told others about my plans to start"
      },
      {
        "pyramid_id": 3,
        "model_category": "Contemplation",
        "card_detail": "I can see the benefits of starting more clearly"
      },
      {
        "pyramid_id": 4,
        "model_category": "Pre Contemplation",
        "card_detail": "I haven't experienced any negative consequences as a result of not starting this behavior"
      },
      {
        "pyramid_id": 5,
        "model_category": "Pre Contemplation",
        "card_detail": "I don't think I could start even if I wanted to"
      },
      {
        "pyramid_id": 6,
        "model_category": "Action",
        "card_detail": "I am taking steps to do this behavior each day"
      },
      {
        "pyramid_id": 7,
        "model_category": "Preparation",
        "card_detail": "I am seeking resources that will help me get started"
      },
      {
        "pyramid_id": 8,
        "model_category": "Action",
        "card_detail": "I am asking others for help"
      },
      {
        "pyramid_id": 9,
        "model_category": "Pre Contemplation",
        "card_detail": "I am not interested in starting this behavior right now"
      },
      {
        "pyramid_id": 10,
        "model_category": "Action",
        "card_detail": "I am working to reduce my stress and anxiety to help me stay on track"
      }
    ]
  }
}

401: Unauthorized

{
  "message": "Unauthentiated"
}

Notes

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

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