Create Get a data of a particular flow from BigQuery.md #370
Conversation
added the get data from BQ section under reporting and dashboard
WalkthroughA new documentation file was introduced, detailing how to retrieve data for a specific flow from BigQuery. The guide provides step-by-step instructions, sample SQL queries, and explanations on extracting and exporting flow data, including advanced JSON field extraction techniques. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Poem
Note ⚡️ Unit Test Generation is now available in beta!Learn more here, or try it out under "Finishing Touches" below. ✨ Finishing Touches🧪 Generate unit tests
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
🚀 Deployed on https://deploy-preview-370--glific-docs.netlify.app |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (7)
docs/3. Product Features/09. Reporting & Dashboard/Get a data of a particular flow from BigQuery.md (7)
1-1: Front-matter formatting is noisy and hard to scanThe long series of
entities bloats the heading and renders inconsistently across Markdown viewers. Stick to a simple badge or plain text.-> ### **3 min read — Beginner** +### **3 min read — Beginner**
4-4: Drop trailing colon from the H2 headingMarkdown-lint (MD026) flags the colon; removing it increases consistency with the rest of the docs.
-## Get Data for a Specific Flow from BigQuery: +## Get Data for a Specific Flow from BigQuery
6-6: Convert bare URL into a proper Markdown linkBare URLs break the reading flow and are flagged by MD034.
-- Login to your Google account https://console.cloud.google.com/ +- Log in to your Google account at <https://console.cloud.google.com/>
8-11: Fix typos and clarify navigation steps
trangle→triangle,clikc→click. Small polish helps users follow the steps without friction.- - Click on small trangle next to your project ID - - Click on small trangle next to the your BOT number - - In the right pane clikc on Query Tab in the Split tab + - Click the small triangle next to your **Project ID** + - Click the small triangle next to your **BOT number** + - In the right pane, click the **Query** tab in the split view
13-13: Use a fenced code block and string literals in the sample queryBack-ticking
flow_namemakes BigQuery treat it as a column, not a string. Quoting avoids copy-paste errors.- - **SELECT * FROM `your_dataset.messages` where flow_name = `flow_name` order by inserted_at DESC** +```sql +SELECT + * +FROM + `your_dataset.messages` +WHERE + flow_name = 'FLOW_NAME' +ORDER BY + inserted_at DESC; +```
15-15: Same MD026 issue — remove trailing colon-## Extract Data by Flow from BigQuery: +## Extract Data by Flow from BigQuery
29-30: BigQuery strings should be single-quoted and avoid camel-case UUID placeholderDouble quotes denote identifiers in standard SQL; here we need a string literal. Also, make clear it’s the flow UUID.
-`your_project.your_dataset.your_table` where uuid = "flow_uuid" +`your_project.your_dataset.your_table` +WHERE uuid = 'FLOW_UUID'
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
docs/3. Product Features/09. Reporting & Dashboard/Get a data of a particular flow from BigQuery.md(1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/3. Product Features/09. Reporting & Dashboard/Get a data of a particular flow from BigQuery.md
4-4: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
6-6: Bare URL used
(MD034, no-bare-urls)
15-15: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
There was a problem hiding this comment.
Can the following be done:
-
Below the heading "get data of specific flow" and "extract data by flow" can the description be added? what does it mean? what kind of data is being extracted
-
Screenshots to show what the bigq tab looks like
-
Can the bullet points be made numbered? so that i becomes easy to reference them
-
What is the query in the last point there for?
-
Can it be mentioned that this query has to be run in "messages" table, not just any table.
-
it is not clear what to replace and how do i use the query to extract the results of a particular flow.
added the get data from BQ section under reporting and dashboard
Summary by CodeRabbit