main.java.com.streamlayer.analytics.studio.v2.DashboardOverviewResponseDataOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of sl-protofiles Show documentation
StreamLayer Java Protofiles
There is a newer version: 5.133.1
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: streamlayer/analytics/v2/studio/dashboard.proto

// Protobuf Java Version: 3.25.3
package com.streamlayer.analytics.studio.v2;

public interface DashboardOverviewResponseDataOrBuilder extends
    // @@protoc_insertion_point(interface_extends:streamlayer.analytics.v2.studio.DashboardOverviewResponseData)
    com.google.protobuf.MessageLiteOrBuilder {

  /**
   *    * Overview page
   * 
   *
   * int32 total_viewers = 1 [json_name = "totalViewers"];
   * @return The totalViewers.
   */
  int getTotalViewers();

  /**
   *    * EMetric.TotalUsers
   * 
   *
   * int32 total_registred_viewers = 2 [json_name = "totalRegistredViewers"];
   * @return The totalRegistredViewers.
   */
  int getTotalRegistredViewers();

  /**
   *    * EMetric.TotalEngagedDevices
   * 
   *
   * int32 total_engaged_viewers = 3 [json_name = "totalEngagedViewers"];
   * @return The totalEngagedViewers.
   */
  int getTotalEngagedViewers();

  /**
   *    * EMetric.TotalEngagedOverlaySession
   * 
   *
   * int32 total_interactions = 4 [json_name = "totalInteractions"];
   * @return The totalInteractions.
   */
  int getTotalInteractions();

  /**
   *    * live EMetric.TotalDevices
   * 
   *
   * int32 live_viewers = 5 [json_name = "liveViewers"];
   * @return The liveViewers.
   */
  int getLiveViewers();

  /**
   *    * live EMetric.TotalEngagedDevices
   * 
   *
   * int32 live_engaged_viewers = 6 [json_name = "liveEngagedViewers"];
   * @return The liveEngagedViewers.
   */
  int getLiveEngagedViewers();

  /**
   *    * round(EMetric.TotalEngagedOverlaySession / EMetric.TotalEngagedDevices, 2)
   * 
   *
   * double interactions_per_engaged_user = 7 [json_name = "interactionsPerEngagedUser"];
   * @return The interactionsPerEngagedUser.
   */
  double getInteractionsPerEngagedUser();

  /**
   * int32 live_registred_viewers = 30 [json_name = "liveRegistredViewers"];
   * @return The liveRegistredViewers.
   */
  int getLiveRegistredViewers();

  /**
   *    * WP/FWP metrics
   * 
   *
   * int32 total_wp_started = 8 [json_name = "totalWpStarted"];
   * @return The totalWpStarted.
   */
  int getTotalWpStarted();

  /**
   *    * Total amount of WP sessions
   * 
   *
   * int32 total_wp_sessions_started = 45 [json_name = "totalWpSessionsStarted"];
   * @return The totalWpSessionsStarted.
   */
  int getTotalWpSessionsStarted();

  /**
   *    * Total Users that Engaged w/ WP (EMetric.TotalUsersEngagedWithWp)
   * 
   *
   * int32 users_engaged_with_wp = 9 [json_name = "usersEngagedWithWp"];
   * @return The usersEngagedWithWp.
   */
  int getUsersEngagedWithWp();

  /**
   *    * Total Users that Engaged w/ WP 2+ (EMetric.TotalUsersEngagedWithWp2plus)
   * 
   *
   * int32 users_engaged_with_active_wp = 10 [json_name = "usersEngagedWithActiveWp"];
   * @return The usersEngagedWithActiveWp.
   */
  int getUsersEngagedWithActiveWp();

  /**
   *    * Total Watch Parties w/ WP 2+ People (EMetric.TotalActiveWps)
   * 
   *
   * int32 active_wps = 11 [json_name = "activeWps"];
   * @return The activeWps.
   */
  int getActiveWps();

  /**
   *    *Average Participants per active WP (2+ participants per WP) (EMetric.AvgParticipantsWp2plus)
   * 
   *
   * double avg_users_active_wp = 12 [json_name = "avgUsersActiveWp"];
   * @return The avgUsersActiveWp.
   */
  double getAvgUsersActiveWp();

  /**
   *    * Average Minutes on WP 2+ (EMetric.AvgActiveWpSessionDuration)
   * 
   *
   * double avg_active_wp_duration = 13 [json_name = "avgActiveWpDuration"];
   * @return The avgActiveWpDuration.
   */
  double getAvgActiveWpDuration();

  /**
   *    * LIVE Participants in WP 2+ People  (live EMetric.TotalUsersEngagedWithWp2plus)
   * 
   *
   * int32 live_users_engaged_with_active_wp = 14 [json_name = "liveUsersEngagedWithActiveWp"];
   * @return The liveUsersEngagedWithActiveWp.
   */
  int getLiveUsersEngagedWithActiveWp();

  /**
   *    * LIVE WP 2+ People (live EMetric.TotalActiveWps)
   * 
   *
   * int32 live_active_wps = 15 [json_name = "liveActiveWps"];
   * @return The liveActiveWps.
   */
  int getLiveActiveWps();

  /**
   *    * Total minutes in WP 2+ with X Participants
   * 
   *
   * double total_min_wp2_users = 16 [json_name = "totalMinWp2Users"];
   * @return The totalMinWp2Users.
   */
  double getTotalMinWp2Users();

  /**
   * double total_min_wp3_users = 17 [json_name = "totalMinWp3Users"];
   * @return The totalMinWp3Users.
   */
  double getTotalMinWp3Users();

  /**
   * double total_min_wp4_users = 18 [json_name = "totalMinWp4Users"];
   * @return The totalMinWp4Users.
   */
  double getTotalMinWp4Users();

  /**
   * double total_min_wp5_users = 19 [json_name = "totalMinWp5Users"];
   * @return The totalMinWp5Users.
   */
  double getTotalMinWp5Users();

  /**
   * double total_min_wp6_users = 20 [json_name = "totalMinWp6Users"];
   * @return The totalMinWp6Users.
   */
  double getTotalMinWp6Users();

  /**
   * double total_min_wp7_users = 21 [json_name = "totalMinWp7Users"];
   * @return The totalMinWp7Users.
   */
  double getTotalMinWp7Users();

  /**
   * double total_min_wp8_users = 22 [json_name = "totalMinWp8Users"];
   * @return The totalMinWp8Users.
   */
  double getTotalMinWp8Users();

  /**
   * double total_min_wp9_users = 23 [json_name = "totalMinWp9Users"];
   * @return The totalMinWp9Users.
   */
  double getTotalMinWp9Users();

  /**
   *    * Total Users that Started a WP (EMetric.TotalUsersStartedWp)
   * 
   *
   * int32 total_users_started_wp = 24 [json_name = "totalUsersStartedWp"];
   * @return The totalUsersStartedWp.
   */
  int getTotalUsersStartedWp();
}