Skip to main content
GET
/
v1
/
metrics
Go (SDK)
package main

import(
	"context"
	"os"
	polargo "github.com/polarsource/polar-go"
	"github.com/polarsource/polar-go/types"
	"github.com/polarsource/polar-go/models/components"
	"github.com/polarsource/polar-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := polargo.New(
        polargo.WithSecurity(os.Getenv("POLAR_ACCESS_TOKEN")),
    )

    res, err := s.Metrics.Get(ctx, operations.MetricsGetRequest{
        StartDate: types.MustDateFromString("2025-03-14"),
        EndDate: types.MustDateFromString("2025-03-18"),
        Interval: components.TimeIntervalHour,
        OrganizationID: nil,
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.MetricsResponse != nil {
        // handle response
    }
}
{
  "periods": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "orders": 123,
      "revenue": 123,
      "net_revenue": 123,
      "cumulative_revenue": 123,
      "net_cumulative_revenue": 123,
      "costs": 123,
      "cumulative_costs": 123,
      "average_order_value": 123,
      "net_average_order_value": 123,
      "average_revenue_per_user": 123,
      "cost_per_user": 123,
      "active_user_by_event": 123,
      "one_time_products": 123,
      "one_time_products_revenue": 123,
      "one_time_products_net_revenue": 123,
      "new_subscriptions": 123,
      "new_subscriptions_revenue": 123,
      "new_subscriptions_net_revenue": 123,
      "renewed_subscriptions": 123,
      "renewed_subscriptions_revenue": 123,
      "renewed_subscriptions_net_revenue": 123,
      "active_subscriptions": 123,
      "monthly_recurring_revenue": 123,
      "committed_monthly_recurring_revenue": 123,
      "checkouts": 123,
      "succeeded_checkouts": 123,
      "checkouts_conversion": 123,
      "canceled_subscriptions": 123,
      "canceled_subscriptions_customer_service": 123,
      "canceled_subscriptions_low_quality": 123,
      "canceled_subscriptions_missing_features": 123,
      "canceled_subscriptions_switched_service": 123,
      "canceled_subscriptions_too_complex": 123,
      "canceled_subscriptions_too_expensive": 123,
      "canceled_subscriptions_unused": 123,
      "canceled_subscriptions_other": 123,
      "gross_margin": 123,
      "gross_margin_percentage": 123,
      "cashflow": 123
    }
  ],
  "totals": {
    "orders": 123,
    "revenue": 123,
    "net_revenue": 123,
    "cumulative_revenue": 123,
    "net_cumulative_revenue": 123,
    "costs": 123,
    "cumulative_costs": 123,
    "average_order_value": 123,
    "net_average_order_value": 123,
    "average_revenue_per_user": 123,
    "cost_per_user": 123,
    "active_user_by_event": 123,
    "one_time_products": 123,
    "one_time_products_revenue": 123,
    "one_time_products_net_revenue": 123,
    "new_subscriptions": 123,
    "new_subscriptions_revenue": 123,
    "new_subscriptions_net_revenue": 123,
    "renewed_subscriptions": 123,
    "renewed_subscriptions_revenue": 123,
    "renewed_subscriptions_net_revenue": 123,
    "active_subscriptions": 123,
    "monthly_recurring_revenue": 123,
    "committed_monthly_recurring_revenue": 123,
    "checkouts": 123,
    "succeeded_checkouts": 123,
    "checkouts_conversion": 123,
    "canceled_subscriptions": 123,
    "canceled_subscriptions_customer_service": 123,
    "canceled_subscriptions_low_quality": 123,
    "canceled_subscriptions_missing_features": 123,
    "canceled_subscriptions_switched_service": 123,
    "canceled_subscriptions_too_complex": 123,
    "canceled_subscriptions_too_expensive": 123,
    "canceled_subscriptions_unused": 123,
    "canceled_subscriptions_other": 123,
    "gross_margin": 123,
    "gross_margin_percentage": 123,
    "cashflow": 123
  },
  "metrics": {
    "orders": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_costs": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "net_average_order_value": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_revenue_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cost_per_user": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "active_user_by_event": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "one_time_products_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "renewed_subscriptions_net_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "active_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "committed_monthly_recurring_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "succeeded_checkouts": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "checkouts_conversion": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_customer_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_low_quality": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_missing_features": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_switched_service": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_complex": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_too_expensive": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_unused": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "canceled_subscriptions_other": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "gross_margin_percentage": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cashflow": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    }
  }
}

Authorizations

​
Authorization
string
header
required

You can generate an Organization Access Token from your organization's settings.

Query Parameters

​
start_date
string<date>
required

Start date.

​
end_date
string<date>
required

End date.

​
timezone
string
default:UTC

Timezone to use for the timestamps. Default is UTC.

Minimum string length: 1
​
interval
enum<string>
required

Interval between two timestamps.

Available options:
year,
month,
week,
day,
hour
​
organization_id

Filter by organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

​
product_id

Filter by product ID.

​
billing_type

Filter by billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.

Available options:
one_time,
recurring
​
customer_id

Filter by customer ID.

Response

Successful Response

Metrics response schema.

​
periods
MetricPeriod · object[]
required

List of data for each timestamp.

​
totals
MetricsTotals · object
required

Totals for the whole selected period.

​
metrics
Metrics · object
required

Information about the returned metrics.