Applies To: 

• Pinnacle Series Administrators.
   

Common Causes/Issues:

• The Pinnacle Series API enables secure, programmatic access to user activity, content usage, learning progress, and assessment results.

Solution Overview:

Summary Table of API Calls
 

Registered Users API – POST /reporting/registeredUsers

This API returns all user records, including account creation, deletion/anonymization flags, org context, and lifetime login counts. Use it for lifecycle tracking, adoption trends, and segmenting by attributes, groups, and managers.

Sample Response: 

{ "data": [ { "login_id": "string", "tenant_id": "string", "user_id": "string", "display_name": "string", "email": "string", "attributes": [ "string" ], "groups": [ "string" ], "managers": [ "string" ], "login_date": "2025-07-29T09:42:02.195Z", "logout_date": "2025-07-29T09:42:02.195Z", "pinnacle_version": "string", "device": "string", "ip_address": "string" } ], "totalCount": 0 }    

Field Descriptions:

Handling Array Fields (attributes & groups) in the Fact Table

• Create helper columns for quick filtering: attributes_concat and groups_concat.
• Use pipe-wrapped tokens joined by a stable delimiter to avoid substring collisions, e.g. |Architect|;|Region: EMEA| and |EMEA > UK > London|;|BIM Managers|.
• For scalable slicing/hierarchies, build bridge tables: User × Attribute, User × GroupPath, related to Users via user_id.

Power Query (M) pattern for concatenated helpers

// Attributes → attributes_concat
= Table.AddColumn(Source, "attributes_concat", each
let
  L = if Value.Is([attributes], type list) then [attributes]
      else try Json.Document([attributes]) otherwise {},
  wrapped = List.Transform(L, each "|" & Text.From(_) & "|")
in
  Text.Combine(wrapped, "|;|"), type text)

// Groups → groups_concat
= Table.AddColumn(PreviousStep, "groups_concat", each
let
  L = if Value.Is([groups], type list) then [groups]
      else try Json.Document([groups]) otherwise {},
  wrapped = List.Transform(L, each "|" & Text.From(_) & "|")
in
  Text.Combine(wrapped, "|;|"), type text)
    

Joins & Filters

• Join key: user_id → Logins, CourseEnrollments, ResourcesAccessed.
• Common filters: created_date between Start/End; optional is_deleted = false; optional tenant_id for multi-tenant.
• Paging: use totalCount to iterate pages and display overall counts.

Logins API – POST /reporting/logins

Returns login and logout records for each user session, including device type, Pinnacle version, and timestamped activity. Useful for auditing access patterns, identifying peak usage windows, and troubleshooting device-related issues.

Sample Response:

 { "data": [ { "login_id": "string", "tenant_id": "string", "user_id": "string", "display_name": "string", "email": "string", "attributes": [ "string" ], "groups": [ "string" ], "managers": [ "string" ], "login_date": "2025-07-29T09:42:02.195Z", "logout_date": "2025-07-29T09:42:02.195Z", "pinnacle_version": "string", "device": "string", "ip_address": "string" } ], "totalCount": 0 } 

Field Descriptions:

Searches API – POST /reporting/searches

Returns all search events triggered by users. Use this to monitor platform discoverability, evaluate search effectiveness, and identify knowledge gaps based on search intent.

Sample Response:

 { "data": [ { "search_id": "string", "tenant_id": "string", "user_id": "string", "display_name": "string", "email": "string", "attributes": ["string"], "groups": ["string"], "managers": ["string"], "search_date": "2025-07-16T15:50:12.146Z", "search_term": "string" } ], "totalCount": 0 } 

Field Descriptions:

Resources Accessed API – POST /reporting/resourcesAccessed

Returns detailed records of each user interaction with content, including the user’s metadata, content type, categories, and the method of access. Ideal for measuring content effectiveness, identifying popular resources, and analyzing user journeys.

Sample Response:

 { "data": [ { "access_id": "string", "tenant_id": "string", "user_id": "string", "display_name": "string", "email": "string", "attributes": [ "string" ], "groups": [ "string" ], "managers": [ "string" ], "accessed_date": "2025-07-29T10:17:41.167Z", "content_id": "string", "content_name": "string", "content_type": "string", "publisher": "string", "topics": [ "string" ], "subtopics": [ "string" ], "libraries": [ "string" ], "referred_by": "string" } ], "totalCount": 0 } 

Field Descriptions:

Enrollments API – POST /reporting/courseEnrollments

Returns detailed records of course enrollments, including user info, assignment details, time metrics, SCORM/personalized flags, quiz results, and progress. Ideal for compliance tracking, progress analysis, and training strategy optimization.

Sample Response:

 { "data": [ { "enrollment_id": "string", "tenant_id": "string", "assigned_to_user_id": "string", "assigned_to_display_name": "string", "assigned_to_email": "string", "assigned_date": "2025-07-29T09:43:58.376Z", "assigned_by_user_id": "string", "assigned_by_display_name": "string", "attributes": ["string"], "groups": ["string"], "managers": ["string"], "course_id": "string", "course_version": "string", "topics": ["string"], "subtopics": ["string"], "libraries": ["string"], "course_duration_minutes": 0, "assigned_minutes": 0, "viewed_minutes": 0, "publisher": "string", "percent_reviewed": 0, "learning_path_id": "string", "learning_path": "string", "status": "string", "quiz_status": "string", "due_date": "2025-07-29T09:43:58.376Z", "completed_date": "2025-07-29T09:43:58.376Z", "dropped_date": "2025-07-29T09:43:58.376Z", "is_self_enrolled": true, "has_due_date": true, "is_completed": true, "is_dropped": true, "is_scorm": true, "is_personalized": true, "assessment": "string" } ], "totalCount": 0 } 

Field Descriptions:

Content API – POST /reporting/content

Returns all content metadata for inventory, categorization, and audit reporting.

Sample Response:

 { "data": [ { "content_id": "string", "content_name": "string", "content_type": "string", "courses": ["string"], "learning_paths": ["string"], "topics": ["string"], "subtopics": ["string"], "libraries": ["string"], "url": "string", "duration_minutes": 0, "calculated_duration": 0, "video_duration": "string", "difficulty": "string", "publisher": "string", "created_date": "2025-07-25T11:19:45.838Z", "created_by": "string", "modified_date": "2025-07-25T11:19:45.838Z", "modified_by": "string", "last_accessed_date": "2025-07-25T11:19:45.838Z", "last_accessed_by": "string", "learning_tags": ["string"], "command_tags": ["string"], "keywords": ["string"], "folder": "string", "parent_folder": "string", "folder_path": "string" } ], "totalCount": 0 } 

Field Descriptions:

Models Section – Understanding API Response Structure

The Models section in Swagger UI documents the exact structure of the data objects that underpin these API responses. These models reflect the way Pinnacle Series stores this information and serve as a reference so technical teams can plan integrations with confidence, knowing exactly what fields, data types, and structures to expect.

Why this matters:

• These models help developers understand exactly what information will come back in API responses.
• They serve as a schema blueprint so teams can efficiently parse, store, and integrate this data into their own systems (e.g., databases, reporting tools, dashboards).
• The models also ensure that integrations handle fields like arrays (e.g., topics, groups, managers) and dates (accessed_date) properly.

How you might use this:

• To design integrations that expect consistent field names and data types.
• To map API response fields to internal reporting structures or analytics platforms.
• To identify what data points are available for building dashboards or reports before writing queries or building connectors.
• You don’t need to reference or use these model names directly — they serve as documentation aids, not API input requirements.
• Field names and types in these models match what you receive in API responses, making it easier to plan integrations, parsing, and data joins.

Still Need Help? 

Log a support ticket