Metrics
Metrics API operations.
Summary
Functions
Create Metric Dashboard
Delete Metric Dashboard
Export Metrics
Get Metric Dashboard
Get Metrics
Get Metrics Limits
List Metric Dashboards
Update Metric Dashboard
Functions
@spec create_metric_dashboard(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricDashboardSchema.t()} | {:error, PolarExpress.Error.t()}
Create Metric Dashboard
Create a user-defined metric dashboard.
Scopes: metrics:write
See PolarExpress.Params.MetricsCreateMetricDashboardParams for parameter details.
@spec delete_metric_dashboard(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Client.response_data()} | {:error, PolarExpress.Error.t()}
Delete Metric Dashboard
Delete a user-defined metric dashboard.
Scopes: metrics:write
See PolarExpress.Params.MetricsDeleteMetricDashboardParams for parameter details.
@spec export_metrics(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Client.raw_response()} | {:error, PolarExpress.Error.t()}
Export Metrics
Export metrics as a CSV file.
Scopes: metrics:read
See PolarExpress.Params.MetricsExportMetricsParams for parameter details.
@spec get_metric_dashboard(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricDashboardSchema.t()} | {:error, PolarExpress.Error.t()}
Get Metric Dashboard
Get a user-defined metric dashboard by ID.
Scopes: metrics:read
See PolarExpress.Params.MetricsGetMetricDashboardParams for parameter details.
@spec get_metrics(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricsResponse.t()} | {:error, PolarExpress.Error.t()}
Get Metrics
Get metrics about your orders and subscriptions.
Currency values are output in cents.
Scopes: metrics:read
See PolarExpress.Params.MetricsGetMetricsParams for parameter details.
@spec get_metrics_limits(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricsLimits.t()} | {:error, PolarExpress.Error.t()}
Get Metrics Limits
Get the interval limits for the metrics endpoint.
Scopes: metrics:read
See PolarExpress.Params.MetricsGetMetricsLimitsParams for parameter details.
@spec list_metric_dashboards(PolarExpress.Client.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricDashboardSchema.t()} | {:error, PolarExpress.Error.t()}
List Metric Dashboards
List user-defined metric dashboards.
Scopes: metrics:read
See PolarExpress.Params.MetricsListMetricDashboardsParams for parameter details.
@spec update_metric_dashboard(PolarExpress.Client.t(), String.t(), map(), keyword()) :: {:ok, PolarExpress.Schemas.MetricDashboardSchema.t()} | {:error, PolarExpress.Error.t()}
Update Metric Dashboard
Update a user-defined metric dashboard.
Scopes: metrics:write
See PolarExpress.Params.MetricsUpdateMetricDashboardParams for parameter details.