Skip to content

docs: clarify HSM delivery dashboard setup and sharing steps #647

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mahajantejas merged 4 commits into from
Jul 20, 2026
Merged

docs: clarify HSM delivery dashboard setup and sharing steps #647

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
32bf043
docs: clarify Contacts table step and dashboard sharing settings
sangeeta1911 Jul 6, 2026
1f01e07
docs: add standard header with Last Updated date, drop backticks in n…
sangeeta1911 Jul 6, 2026
86d51a6
Merge branch 'main' into docs/hsm-delivery-dashboard-update
SangeetaMishr Jul 14, 2026
2968041
Merge branch 'main' into docs/hsm-delivery-dashboard-update
mahajantejas Jul 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 13 additions & 1 deletion ... Features/09. Reporting & Dashboard/08. How To Set Up HSM Delivery Dashboard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
### **4 minute read                                                                                                                         `Advanced`**
<h3>
<table>
<tr>
<td><b>4 minutes read</b></td>

@coderabbitai coderabbitai Bot Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Fix the read-time label.

Use “4-minute read” or “4 minutes to read”; “4 minutes read” is grammatically incorrect.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md at line 4, Update the read-time label in the documentation
from “4 minutes read” to the grammatically correct “4-minute read” or “4 minutes
to read,” while preserving the existing formatting.

<td style={{ paddingLeft: '40px' }}><b>Level: Advanced</b></td>
<td style={{ paddingLeft: '40px' }}><b>Last Updated: July 2026</b></td>
</tr>
</table>
</h3>
Comment on lines +1 to +9

@coderabbitai coderabbitai Bot Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Start the document with a top-level heading.

The first line is an <h3>, triggering markdownlint MD041 and weakening document navigation/accessibility. Add a # heading before the status table and keep the table outside the heading element.

🧰 Tools
🪛 markdownlint-cli2 (0.23.0)

[warning] 1-1: First line in a file should be a top-level heading

(MD041, first-line-heading, first-line-h1)

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md around lines 1 - 9, Prepend a top-level Markdown heading
before the existing status table in the HSM Delivery Dashboard document. Keep
the metadata table outside the current h3 element and preserve its existing
contents and formatting.

Source: Linters/SAST tools



### Problem: How to find the number of contacts who did not get the business initiated message due to frequency capping regulations imposed by Meta on Marketing HSMs.
Expand Down Expand Up @@ -40,6 +48,8 @@ app, destination, type, reason, sent_on, flow_name, template_id, message, m.medi
### 1. Sign into Bigquery using the appropriate email account and select the options to run a query.
- Navigate to bigquery. Expand the phone number (aka dataset) and select `Contacts` table

- Note: This step is only to open the query editor within the correct dataset context - the query itself reads from the messages table, not Contacts.

<img width="304" alt="Screenshot 2025-05-12 at 2 40 53 PM" src="https://github.com/user-attachments/assets/429557a7-a146-4841-a337-266fb2c13984" />

- Click on the “Query’ button to create an empty query
Expand Down Expand Up @@ -74,6 +84,8 @@ lets move to Part 2
- Sign in to your Look Studio space using your work google account associated with BigQuery

- Open this link - https://lookerstudio.google.com/u/0/reporting/859eb34f-2f9a-410c-8baa-dacf28af6c33/page/oBhGF/preview in your browser

- Note: This is a preview link tied to the report owner's account. Before sharing your own copy of this dashboard with your team, click Share in Looker Studio and set access to "Anyone with the link" → Viewer, so teammates outside your account can open it too.

@coderabbitai coderabbitai Bot Jul 14, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔒 Security & Privacy | 🟠 Major | ⚡ Quick win

Do not present “Anyone with the link” as equivalent to teammate-only access.

This setting allows anyone who obtains the URL to view the dashboard, which can expose the contact names and phone numbers referenced later in the guide. Prefer specific users/groups or add an explicit approval/privacy caveat; also clarify that the report owner must change sharing on the owner-bound preview, or that users should share their own copy.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@docs/4`. Product Features/09. Reporting & Dashboard/08. How To Set Up HSM
Delivery Dashboard.md at line 88, Revise the dashboard sharing note to avoid
equating “Anyone with the link” with teammate-only access. Recommend specific
users or groups where possible, and add an explicit privacy/approval caveat if
that public-link setting is used; clarify that the report owner must update
sharing on the preview or users should share their own copy.

- In the top right corner, you will see 2 buttons next to your user profile icon
<img width="739" alt="Screenshot 2025-05-12 at 3 09 14 PM" src="https://github.com/user-attachments/assets/aa6221f3-74a2-4cd5-bba2-65845b9ac64e" />

Expand Down
Loading