1. Widget
Turf API Documentation
  • Users
    • Create Community Member
      POST
    • Update Community Member's Profile
      PUT
    • Get Community Members
      GET
    • Block Community Member
      PUT
    • Get Community Member's Details
      GET
    • Get Member's Created Posts
      GET
    • Get Member's Saved Posts
      GET
    • Get Member's Comments
      GET
  • Channels
    • Get Community Channels
      GET
    • Get Roadmap Channel Status
      GET
  • Posts
    • Create Discussion Post
      POST
    • Update Discussion Post
      PUT
    • Create Article Post
      POST
    • Update Article Post
      PUT
    • Top Community Posts
      GET
    • Get Channel's Posts
      GET
    • Get Discussion Post Details
      GET
    • Get Article Post Details
      GET
    • Update Roadmap Post Status
      PUT
  • Courses
    • Top Community Courses
      GET
  • Segments
    • Get Community Segments
    • Add Member To Segment
    • Remove Member From Segment
  • Gamification
    • Get Community Badges
    • Award Badge To Member
    • Remove Badge From Member
  • Comments
    • Create Comment On Post
    • Update Comment On Post
    • Delete Existing Comment
    • Create comment on comment
  • Topics
    • Get Topics
  • Metrics
    • Widget
      • Widget Opens Series
        GET
      • Widget Opens Aggregate
        GET
      • Widget Engagement Snapshot
        GET
    • Platform
      • Dashboard Metrics Series
        • Total Members (cumulative)
        • New Members
        • Active Users
        • Unanswered Posts
        • Visitor Members (via dashboard-metrics)
        • Visitor Non-Members (via dashboard-metrics)
      • Activities
      • Post Metrics
      • New Members Aggregate
      • Resolved Chats Aggregate
      • Visitor Metrics — Member
      • Visitor Metrics — Non-Member
      • Visitor Source Pivot
      • Visitor Source Series
      • Dashboard Rollup
      • Day Most Active
      • Helpful Support Cost
      • Support Ticket Deflected
      • Dashboard Members Card
      • Dashboard Posts Counts
      • Community Metrics Snapshot
      • Community Metrics By Type
      • Community Metrics By Type (with range)
      • Total Members Community
  1. Widget

Widget Engagement Snapshot

GET
https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/dashboard-widget-users-metrics
Composite widget engagement: members via widget, session duration, post impressions, posts, comments (source='widget'), redirects.
Each metric includes % of community-wide and Δ vs past 30-day-shifted window.
Date mode: query param type (acts as dateConfig). Default day.
Response: { members, session_duration, post_impressions, posts, comments, redirects }

Request

Query Params

Header Params

Responses

🟢200
application/json
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --globoff 'https://2e0a7m2i9j.execute-api.eu-central-1.amazonaws.com/prod/community/v1/dashboard-widget-users-metrics?startDate={{startDate}}&endDate={{endDate}}&type={{dateConfig}}' \
--header 'x-api-key: api_key'
Response Response Example
{}
Modified at 2026-08-12 11:22:50
Previous
Widget Opens Aggregate
Next
Platform
Built with