docs(analytics): list the platforms with per-post metrics and complete the TikTok row - #245
docs(analytics): list the platforms with per-post metrics and complete the TikTok row#245giladresisi wants to merge 1 commit into
Conversation
…e the TikTok row Adds a "Per-post metrics" section to the Analytics guide, generated from the app repo by scripts/sync-facts.mjs (new post-analytics region derived from which providers implement postAnalytics), links the opening paragraph and the Statistics note on the post actions page to it, and completes the TikTok row in "What each platform reports" with the metrics the provider actually returns. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Roikk7Asuuix92LqWmpNop
✅ Snyk checks have passed. No issues have been found so far.
💻 Catch issues earlier using the plugins for VS Code, JetBrains IDEs, Visual Studio, and Eclipse. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Team Run ID: 📒 Files selected for processing (3)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. 📝 WalkthroughWalkthroughThe sync script now generates a per-post analytics table from provider implementations. The Analytics documentation adds this table, expands TikTok metrics, and updates links to the new section. ChangesPer-post analytics documentation
Estimated code review effort: 2 (Simple) | ~10 minutes Merge Risk: ⚪ Minimal · up to This PR updates analytics documentation and its generated platform list without introducing an actionable merge-blocking risk; it is merge-ready after normal checks and review. Suggested reviewers: 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Docstring CoverageExplanation Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 3 functions across 1 files. (2 skipped: 2 unsupported.)
✨ Finishing Touches 💡 2📝 Generate docstrings 💡
🛠️ Fix failing CI checks 💡
🧪 Generate unit tests (beta)
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. Comment |
What
Adds a "Per-post metrics" section to the Analytics guide listing the 12 platforms whose provider reports per-post statistics. The list is a generated region written by
scripts/sync-facts.mjs(newpost-analyticsregion, derived from which providers implementpostAnalytics), so it cannot drift from the app. It points out that Dribbble and TikTok Business report per-post metrics but have no account-level analytics.Links the opening paragraph of the Analytics page and the Statistics note on the post actions page to this section.
Completes the TikTok row in "What each platform reports" with the metrics the provider actually returns (views, recent likes, recent comments, recent shares).
Why
A customer using the public per-post analytics endpoint on TikTok posts reported three things: the endpoint returned an empty array for their posts, the post's
releaseURLwas the channel's profile link rather than the video, and when they tried to find out which platforms support per-post metrics at all, the docs sent them in a loop. The Analytics page said per-post numbers live on the post, and the post page said to see Analytics for which platforms report them, with neither page listing them.This PR fixes the loop and the list. The TikTok empty-array and
releaseURLbehaviour depend on an app change (gitroomhq/postiz-app#2007) and are documented in a separate PR gated on that deploy.While checking the list, the TikTok account-level row turned out to list 4 of the 8 metrics the provider returns. The other rows were checked against each provider's
analytics()labels and match.Testing
Rendered the Analytics and Post actions pages locally with
mint devin a real browser: the new section, the anchor links and the table render without overflow.node scripts/check-docs.mjs --changedandnode scripts/check-prose.mjs --changedpass. Running the generator against the app repo only changes the new region; the existing analytics table is untouched.Not gated on any deploy.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Roikk7Asuuix92LqWmpNop
Summary by CodeRabbit