Get Metrics Limits

Get the interval limits for the metrics endpoint.

Scopes: metrics:read

GET /v1/metrics/limits

Go (SDK)

Go

package main

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

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

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

    res, err := s.Metrics.Limits(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.MetricsLimits != nil {
        // handle response
    }
}

200

{
  "min_date": "2023-12-25",
  "intervals": {
    "hour": {
      "min_days": 123,
      "max_days": 123
    },
    "day": {
      "min_days": 123,
      "max_days": 123
    },
    "week": {
      "min_days": 123,
      "max_days": 123
    },
    "month": {
      "min_days": 123,
      "max_days": 123
    },
    "year": {
      "min_days": 123,
      "max_days": 123
    }
  }
}

Authorizations

Authorization · string · header · required

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

Response

200 - application/json

Successful Response

Date limits to get metrics.

min_date · string<date> · required

Minimum date to get metrics.

intervals · MetricsIntervalsLimits · object · required

Limits for each interval.

Show child attributes