Group Data Source for Analytics - HL Vanilla Community
<main> <article class="userContent"> <p><strong>📝 NOTE</strong>: It is assumed you know how to create custom Dashboards and Charts. If not, <a href="https://success.vanillaforums.com/kb/articles/433#building-custom-charts-dashboards" rel="nofollow noreferrer ugc">read this article</a> before proceeding.</p><p>When building your own Dashboard Charts, you can pull data from various <strong>data sources</strong> to view different types of analytics events. </p><ul><li>In this article, we're going to focus on the <strong>Group </strong>data source, which tracks all Group activity across your <strong>Higher Logic Vanilla (Vanilla)</strong> community.</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/MQ6L0ZWSKFBV/group-ds.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/MQ6L0ZWSKFBV/group-ds.png" alt="Group_DS.png" height="813" width="1109" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="overview">Overview</h2><p>The Group data source tracks when:</p><ul><li>A Group is added</li><li>A Group is updated</li><li>A Group is deleted</li><li>A user joins a Group</li><li>A user leaves a Group</li></ul><p>For each Group event logged, you can see:</p><ul><li>The <strong>type </strong>of Group activity that occurred (e.g., joined or left)</li><li>Information about the <strong>Group</strong> associated to the activity:<ul><li><strong>Group ID</strong></li><li><strong>Group Name</strong></li><li><strong>Group Privacy</strong></li></ul></li></ul><ul><li>Information about the <strong>User </strong>who initiated the action:<ul><li><strong>User ID</strong></li><li><strong>User Name</strong></li><li><strong>User UUID</strong></li><li><strong>User Rank Name</strong></li><li><strong>User Rank ID</strong></li><li><strong>User Role ID</strong></li><li><strong>User Role Name</strong></li><li><strong>User Role Type</strong></li></ul><h2 data-id="filter-chart-data">Filter Chart data</h2><p>Controlling what data is shown in a Chart is accomplished via the <strong>Group By</strong> and <strong>Filter </strong>options.</p><ul><li>The <strong>Group By</strong> options (available for pie graphs, line graphs, bar graphs, and tables) enable you to view data by Group action (type), Group name, and more.</li><li>You can add <strong>Filters </strong>to your query to <em>drill into</em> or <em>exclude</em> specific types of Group events (e.g., exclude specific users from traffic data or focus your Chart on traffic seen in a specific Group).</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/H7IRKPLGGPB2/groupby-filter.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/H7IRKPLGGPB2/groupby-filter.png" alt="GroupBy_Filter.png" height="817" width="1109" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p>Let's learn about each of the available Group By and Filter options.</p><h2 data-id="type">Type</h2><p>Each Group activity logged has a <strong>type. </strong>The type parameter defines what happened:</p><ul><li><strong>add: </strong>a new Group was created</li><li><strong>update: </strong>an existing Group's details were updated</li><li><strong>delete: </strong>a Group was deleted</li><li><strong>join: </strong>a user joined a Group</li><li><strong>leave: </strong>a user left a Group</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/BJHL7M1YR3OP/type.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/BJHL7M1YR3OP/type.png" alt="type.png" height="812" width="1109" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="group-info">Group info</h2><p>Each action logged in the Group data source is associated with a Group. You can Group and/or filter Chart data by:</p><ul><li><strong>Group Name</strong></li><li><strong>Group ID</strong></li><li><strong>Group Privacy: </strong>i.e. Public, Private or Secret Groups</li></ul><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/MSUHX2VKR0QD/group-info.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/MSUHX2VKR0QD/group-info.png" alt="group_info.png" height="811" width="1109" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <h2 data-id="user-info">User Info</h2><p>Each action logged in the Group data source is triggered by a user. These parameters will define the user who has added, edited, or deleted a Group, or the user who has joined or left a Group. You can Group and/or filter chart data by:</p><div class="embedExternal embedImage display-large float-none"> <div class="embedExternal-content"> <a class="embedImage-link" href="https://us.v-cdn.net/6030677/uploads/EJNS6ASHBJHV/user-info.png" rel="nofollow noreferrer noopener ugc" target="_blank"> <img class="embedImage-img" src="https://us.v-cdn.net/6030677/uploads/EJNS6ASHBJHV/user-info.png" alt="user_info.png" height="808" width="1109" loading="lazy" data-display-size="large" data-float="none"></img></a> </div> </div> <p><br></p></li></ul> </article> </main>