Analytics API Reference

Access Rise's UI-Contextual Product Intelligence programmatically.

Base URL

https://api.getrise.ai/v1/analytics

Authentication

Use your API key in the Authorization header:

curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.getrise.ai/v1/analytics/features

Feature Intelligence

Get Feature Usage Data

GET /v1/analytics/features

Query Parameters:

• date_range (string): last_7_days, last_30_days, last_90_days, or custom
• segment (string, optional): Filter by user segment
• include_context (boolean): Include UI context data (default: true)

Response:

{
  "features": [
    {
      "name": "Export",
      "visibility_rate": 0.78,
      "engagement_conversion": 0.76,
      "discovery_gap_score": 0.09,
      "quadrant": "high_visibility_high_usage",
      "users_saw": 1240,
      "users_used": 942,
      "avg_days_to_discovery": 3.2,
      "context": {
        "visible_in_empty_state": 0.42,
        "avg_data_volume_when_used": 234.5
      }
    }
  ],
  "date_range": {
    "start": "2024-09-16",
    "end": "2024-10-16"
  }
}

Get Feature Details

GET /v1/analytics/features/{feature_name}

Response:

{
  "name": "Custom Dashboards",
  "metrics": {
    "visibility_rate": 0.18,
    "engagement_conversion": 0.85,
    "discovery_gap_score": 0.64
  },
  "usage_patterns": {
    "first_week_vr": 0.04,
    "month_2_plus_vr": 0.35,
    "avg_days_to_discovery": 23
  },
  "discovery_methods": {
    "browsing": 0.45,
    "power_user_exploration": 0.28,
    "recommendation": 0.18,
    "documentation": 0.09
  },
  "segmented_usage": [
    {
      "segment": "new_users",
      "visibility_rate": 0.08,
      "engagement_conversion": 0.15
    },
    {
      "segment": "power_users",
      "visibility_rate": 0.48,
      "engagement_conversion": 0.78
    }
  ]
}

Workflows

Get Auto-Discovered Workflows

GET /v1/analytics/workflows

Query Parameters:

• goal (string, optional): Filter by goal/outcome
• min_frequency (number): Minimum occurrence count

Response:

{
  "workflows": [
    {
      "goal": "Create Report",
      "path": [
        "Dashboard",
        "Reports",
        "New Report",
        "Template",
        "Generate"
      ],
      "frequency": 0.45,
      "efficiency_score": 1.0,
      "avg_time": 135,
      "completion_rate": 0.92
    },
    {
      "goal": "Create Report",
      "path": [
        "Dashboard",
        "Search",
        "Reports",
        "New Report",
        "Template",
        "Generate"
      ],
      "frequency": 0.28,
      "efficiency_score": 0.83,
      "avg_time": 165,
      "completion_rate": 0.87
    }
  ]
}

Get Workflow Efficiency

GET /v1/analytics/workflows/{workflow_id}/efficiency

Response:

{
  "workflow_id": "wf_abc123",
  "goal": "Export Data",
  "optimal_steps": 4,
  "actual_avg_steps": 6.2,
  "efficiency_score": 0.64,
  "friction_points": [
    {
      "step": "Format Selection",
      "friction_index": 7.8,
      "common_issues": ["confusion", "backtracking"]
    }
  ]
}

Cohorts

List Behavioral Cohorts

GET /v1/analytics/cohorts

Response:

{
  "cohorts": [
    {
      "id": "cohort_power_users",
      "name": "Power Users",
      "type": "behavioral",
      "size": 156,
      "percentage": 0.12,
      "characteristics": {
        "avg_features_used": 23,
        "daily_active_rate": 0.94,
        "avg_session_length": 2520,
        "efficiency_score": 0.87
      },
      "churn_risk": "very_low",
      "expansion_opportunity": "high"
    },
    {
      "id": "cohort_stuck_users",
      "name": "Stuck Users",
      "type": "behavioral",
      "size": 234,
      "percentage": 0.18,
      "characteristics": {
        "friction_index": 8.2,
        "loop_patterns_rate": 0.42,
        "avg_features_used": 4
      },
      "churn_risk": "very_high",
      "expansion_opportunity": "low"
    }
  ]
}

Get Cohort Details

GET /v1/analytics/cohorts/{cohort_id}

Get Cohort Users

GET /v1/analytics/cohorts/{cohort_id}/users

Friction Detection

Get Friction Heatmap

GET /v1/analytics/friction

Query Parameters:

• page (string, optional): Filter by page/route
• min_friction_index (number): Minimum FI threshold

Response:

{
  "friction_points": [
    {
      "page": "/reports",
      "element": "Advanced Options",
      "friction_index": 7.8,
      "signals": {
        "dead_clicks": 45,
        "rage_clicks": 23,
        "confusion_loops": 12,
        "avg_idle_time": 120
      },
      "users_affected": 234,
      "recommended_actions": [
        "Simplify options interface",
        "Add contextual help",
        "Create guided flow"
      ]
    }
  ]
}

Get Friction Trends

GET /v1/analytics/friction/trends

Response:

{
  "trends": [
    {
      "workflow": "Export Data",
      "friction_history": [
        { "date": "2024-10-01", "friction_index": 3.2 },
        { "date": "2024-10-08", "friction_index": 4.1 },
        { "date": "2024-10-15", "friction_index": 4.8 }
      ],
      "trend": "increasing",
      "percent_change": 0.5,
      "alert_level": "warning"
    }
  ]
}

Contextual "Why" Analysis

Get Context for Events

GET /v1/analytics/context/events/{event_name}

Response:

{
  "event": "export_clicked",
  "total_occurrences": 1240,
  "context_breakdown": {
    "with_data_present": {
      "count": 780,
      "success_rate": 0.92,
      "friction_index": 1.8
    },
    "empty_state": {
      "count": 460,
      "success_rate": 0.08,
      "friction_index": 12.4,
      "common_issues": [
        "Users confused why export doesn't work",
        "Error messages unclear",
        "Don't know how to populate data"
      ]
    }
  },
  "recommendations": [
    "Disable export button when no data",
    "Show tooltip: 'Add data to enable export'",
    "Create Job: 'Populate Your First Data'"
  ]
}

Job Performance

Get Job Analytics

GET /v1/analytics/jobs/{job_id}

Response:

{
  "job_id": "job_abc123",
  "name": "Complete Profile Setup",
  "metrics": {
    "completion_rate": 0.72,
    "avg_time_to_completion": 145,
    "intervention_acceptance_rate": 0.85,
    "users_targeted": 1240,
    "users_completed": 893
  },
  "paths_to_success": [
    {
      "path": ["Profile", "Edit", "Save"],
      "frequency": 0.65,
      "avg_time": 95
    },
    {
      "path": ["Settings", "Profile", "Edit", "Save"],
      "frequency": 0.35,
      "avg_time": 180
    }
  ],
  "drop_off_points": [
    {
      "step": "Company Field",
      "drop_off_rate": 0.38,
      "friction_index": 8.9
    }
  ]
}

Exporting Data

Export Raw Events

GET /v1/analytics/export/events

Query Parameters:

• format: csv or json
• date_range: Date range for export
• event_types (optional): Comma-separated event types

Export to Data Warehouse

POST /v1/analytics/export/warehouse

Request Body:

{
  "destination": "snowflake",
  "credentials": {
    "account": "your-account",
    "database": "analytics",
    "schema": "rise_data"
  },
  "tables": ["events", "users", "features", "workflows"]
}

Scheduled Reports

Create Scheduled Report

POST /v1/analytics/reports

Request Body:

{
  "name": "Weekly Feature Intelligence Report",
  "type": "feature_intelligence",
  "schedule": "weekly",
  "recipients": ["team@example.com"],
  "format": "pdf"
}

Real-Time Streaming

WebSocket Connection

wss://api.getrise.ai/v1/analytics/stream

Authentication:

{
  "type": "auth",
  "api_key": "YOUR_API_KEY"
}

Subscribe to Events:

{
  "type": "subscribe",
  "channels": ["friction_alerts", "job_completions"]
}

Receive Events:

{
  "channel": "friction_alerts",
  "data": {
    "page": "/checkout",
    "friction_index": 8.7,
    "users_affected": 45
  },
  "timestamp": "2024-10-16T14:23:00Z"
}

Next Steps

• Admin API
• Feature Intelligence
• Integrations