Skip to main content
This guide shows how to use the Propal Metrics API to build automated reports and custom dashboards.

Overview

The Metrics API provides read-only access to your organization’s analytics:

Quick example: weekly report

Building a Slack report bot

Send a weekly summary to Slack every Monday:

Building a custom dashboard

Fetch all metrics and display them in your own dashboard:

Combining metrics with proposals

For richer reports, combine metrics with actual proposal data:

Exporting to Google Sheets

Use the Google Sheets API to push your Propal data into a spreadsheet:

Best practices

  • Cache metrics. Most metrics don’t change frequently. Cache them for 5-15 minutes to reduce API calls.
  • Use parallel requests. Fetch multiple metric endpoints simultaneously with Promise.all().
  • Required scope. All metrics endpoints require the metrics:read scope. You don’t need write access.
  • Time ranges. Some endpoints support period parameters (daily, weekly, hourly) to control the granularity.