Get Metrics Limits

Get the interval limits for the metrics endpoint.

Scopes: metrics:read

GET /v1/metrics/limits

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;

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



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

);

if ($response->metricsLimits !== null) {
    // 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