AnalyticsQueryResponse

DataFrame-based response model for analytics queries

  • action
    Type: ActionTypeenum
    required

    Metric/KPI to calculate

    values
    • win_rate
    • lead_conversion_rate
    • lead_qualification_rate
    • lead_analysis_combined
    • stage_conversion_rate_current_to_win
    • stage_conversion_rate_reached_onward
    • stage_conversion_rates_combined
    • milestone_conversion_rates_combined
  • breakdown
    Type: BreakdownTypeenum
    required

    How to group results (secondary breakdown)

    values
    • none
    • month
    • year
    • quarter
    • ae_owner
    • sdr_owner
    • stage
    • milestone
  • dataframe
    Type: AnalyticsDataFrame
    required

    DataFrame-like structure for analytics data

    Properties: 2
  • period
    required
    • Type: ReportPeriodenum

      The time period over which to calculate the report.

      Available time periods:

      • 1 (WEEK): Current week - Current calendar week (Monday to Sunday)
      • 2 (MONTH): Current month - Full current calendar month
      • 3 (QUARTER): Current quarter - Full current 3-month period (Q1-Q4)
      • 4 (YEAR): Current year - Full current calendar year
      • 5 (ROLLING_YEAR): Rolling year - Last 365 days of continuous data
      • 6 (MTD): Month to date - From start of current month to today
      • 11 (ALL_TIMES): All times - Complete historical data without time restrictions, useful for lifetime metrics
      • 12 (YTD): Year to date - From start of current year to today, standard for annual performance tracking
      • 13 (LAST_12_MONTHS): Last 12 months - Previous 12 complete calendar months (including current month)
      • 14 (LAST_24_MONTHS): Last 24 months - Previous 24 complete calendar months (including current month)
      • 15 (LAST_YEAR): Last year - Previous calendar year
      • 16 (LAST_QUARTER): Last quarter - Previous quarter
      • 17 (NEXT_QUARTER): Next quarter
      • 18 (LAST_MONTH): Last month - Previous month
      • 19 (NEXT_MONTH): Next month
      • 20 (NEXT_YEAR): Next year
      values
      • 1000
      • 1
      • 2
      • 3
      • 4
      • 5
      • 6
      • 11
  • scope
    Type: ScopeTypeenum
    required

    Scope type for report calculations: ME=only the user, TEAM=user and subordinates etc.

    values
    meteampeerscompanyorg
  • effectiveEndDate
    Type: stringFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21

  • effectiveStartDate
    Type: stringFormat: datenullable

    full-date notation as defined by RFC 3339, section 5.6, for example, 2017-07-21