GET
/
v1
/
metrics
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-02-06"),
        EndDate: types.MustDateFromString("2024-09-04"),
        Interval: components.TimeIntervalWeek,
        OrganizationID: polargo.Pointer(operations.CreateMetricsGetQueryParamOrganizationIDFilterArrayOfStr(
            []string{
                "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
            },
        )),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.MetricsResponse != nil {
        // handle response
    }
}
{
  "periods": [
    {
      "timestamp": "2023-11-07T05:31:56Z",
      "orders": 123,
      "revenue": 123,
      "cumulative_revenue": 123,
      "average_order_value": 123,
      "one_time_products": 123,
      "one_time_products_revenue": 123,
      "new_subscriptions": 123,
      "new_subscriptions_revenue": 123,
      "renewed_subscriptions": 123,
      "renewed_subscriptions_revenue": 123,
      "active_subscriptions": 123,
      "monthly_recurring_revenue": 123
    }
  ],
  "metrics": {
    "orders": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "cumulative_revenue": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "average_order_value": {
      "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"
    },
    "new_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "new_subscriptions_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"
    },
    "active_subscriptions": {
      "slug": "<string>",
      "display_name": "<string>",
      "type": "scalar"
    },
    "monthly_recurring_revenue": {
      "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
required

Start date.

​
end_date
string
required

End date.

​
interval
enum<string>
required

Interval between two timestamps.

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

Filter by organization ID.

Examples:

"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

200
application/json
Successful Response

Metrics response schema.

​
periods
object[]
required

List of data for each timestamp.

​
metrics
object
required

Information about the returned metrics.