Create Meter

Create a meter.

Scopes: meters:write

POST /v1/meters

PHP (SDK)

PHP

declare(strict_types=1);

require 'vendor/autoload.php';

use Spaire;
use Spaire\Models\Components;

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

$request = new Components\MeterCreate(
    name: '<value>',
    filter: new Components\Filter(
        conjunction: Components\FilterConjunction::Or,
        clauses: [
            new Components\FilterClause(
                property: '<value>',
                operator: Components\FilterOperator::Ne,
                value: '<value>',
            ),
        ],
    ),
    aggregation: new Components\PropertyAggregation(
        func: Components\Func::Max,
        property: '<value>',
    ),
    organizationId: '1dbfc517-0bbf-4301-9ba8-555ca42b9737',
);

$response = $sdk->meters->create(
    request: $request
);

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

201

{
  "metadata": {},
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "name": "<string>",
  "filter": {
    "clauses": [
      {
        "property": "<string>",
        "value": "<string>"
      }
    ]
  },
  "aggregation": {
    "func": "count"
  },
  "organization_id": "<string>",
  "archived_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

You can generate an Organization Access Token from your organization's settings.

Body

application/json

name · string · required

The name of the meter. Will be shown on customer's invoices and usage.

Minimum string length: 3

filter · Filter · object · required

The filter to apply on events that'll be used to calculate the meter.

Show child attributes

aggregation · CountAggregation · object · required

The aggregation to apply on the filtered events to calculate the meter.

CountAggregation

PropertyAggregation

UniqueAggregation

Show child attributes

metadata · Metadata · object

Key-value object allowing you to store additional information.

The key must be a string with a maximum length of 40 characters. The value must be either:

• A string with a maximum length of 500 characters
• An integer
• A floating-point number
• A boolean

You can store up to 50 key-value pairs.

Show child attributes

organization_id · string<uuid4> | null

The organization ID.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

Response

201

application/json

Meter created.

metadata · object · required

Show child attributes

created_at · string<date-time> · required

Creation timestamp of the object.

modified_at · string<date-time> | null · required

Last modification timestamp of the object.

id · string<uuid4> · required

The ID of the object.

name · string · required

The name of the meter. Will be shown on customer's invoices and usage.

filter · Filter · object · required

The filter to apply on events that'll be used to calculate the meter.

Show child attributes

aggregation · CountAggregation · object · required

The aggregation to apply on the filtered events to calculate the meter.

CountAggregation

PropertyAggregation

UniqueAggregation

Show child attributes

organization_id · string<uuid4> · required

The ID of the organization owning the meter.

archived_at · string<date-time> | null

Whether the meter is archived and the time it was archived.