GET
/
v1
/
metrics
/
limits
Typescript (SDK)
import { Polar } from "@polar-sh/sdk";

const polar = new Polar({
  accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "",
});

async function run() {
  const result = await polar.metrics.limits();

  console.log(result);
}

run();
{
  "min_date": "2023-12-25",
  "intervals": {
    "hour": {
      "max_days": 123
    },
    "day": {
      "max_days": 123
    },
    "week": {
      "max_days": 123
    },
    "month": {
      "max_days": 123
    },
    "year": {
      "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
object
required

Limits for each interval.