README.md

Metrics

(metrics)

Overview

Available Operations

• get - Get Metrics
• limits - Get Metrics Limits

get

Get metrics about your orders and subscriptions.

Currency values are output in cents.

Scopes: metrics:read

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Brick\DateTime\LocalDate;
use Polar;
use Polar\Models\Components;
use Polar\Models\Operations;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\MetricsGetRequest(
    startDate: LocalDate::parse('2025-02-06'),
    endDate: LocalDate::parse('2024-09-04'),
    interval: Components\TimeInterval::Week,
    organizationId: [
        '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
    ],
);

$response = $sdk->metrics->get(
    request: $request
);

if ($response->metricsResponse !== null) {
    // handle response
}

Parameters

Parameter	Type	Required	Description
$request	Operations\MetricsGetRequest	✔️	The request object to use for the request.

Response

?Operations\MetricsGetResponse

Errors

Error Type	Status Code	Content Type
Errors\HTTPValidationError	422	application/json
Errors\APIException	4XX, 5XX	*/*

limits

Get the interval limits for the metrics endpoint.

Scopes: metrics:read

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Polar;

$sdk = Polar\Polar::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->metrics->limits(

);

if ($response->metricsLimits !== null) {
    // handle response
}

Response

?Operations\MetricsLimitsResponse

Errors

Error Type	Status Code	Content Type
Errors\APIException	4XX, 5XX	*/*