Skip to content

Latest commit

 

History

History
27 lines (22 loc) · 6.53 KB

metricsgetrequest.md

File metadata and controls

27 lines (22 loc) · 6.53 KB

MetricsGetRequest

Example Usage

import { MetricsGetRequest } from "@polar-sh/sdk/models/operations/metricsget.js";
import { RFCDate } from "@polar-sh/sdk/types/rfcdate.js";

let value: MetricsGetRequest = {
  startDate: new RFCDate("2023-02-26"),
  endDate: new RFCDate("2023-10-22"),
  interval: "year",
  organizationId: "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
};

Fields

Field Type Required Description
startDate RFCDate ✔️ Start date.
endDate RFCDate ✔️ End date.
interval components.TimeInterval ✔️ Interval between two timestamps.
organizationId operations.MetricsGetQueryParamOrganizationIDFilter ➖ Filter by organization ID.
productId operations.MetricsGetQueryParamProductIDFilter ➖ Filter by product ID.
billingType operations.QueryParamProductBillingTypeFilter ➖ Filter by billing type. recurring will filter data corresponding to subscriptions creations or renewals. one_time will filter data corresponding to one-time purchases.
customerId operations.MetricsGetQueryParamCustomerIDFilter ➖ Filter by customer ID.