Skip to main content
GET
/
v1
/
aggregators
/
{id}
Get aggregator
curl --request GET \
  --url https://api.hyperline.co/v1/aggregators/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "entity": "<string>",
  "operation": "count",
  "property": "<string>",
  "where": {
    "conditional": "and",
    "fields": [
      {
        "property": "<string>",
        "operator": "isNull"
      }
    ]
  },
  "type": "metered",
  "name": "<string>",
  "description": "<string>",
  "allow_negative_values": true,
  "custom_event_name": "<string>",
  "exposed_event_keys": [
    "<string>"
  ],
  "created_at": "2023-12-25",
  "updated_at": "2023-12-25"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

id
string
required
entity
string
required
operation
enum<string>
required
Available options:
count,
sum
property
string | null
required
where
object
required
type
enum<string>
required
Available options:
metered,
licensed
name
string | null
required
description
string | null
required
allow_negative_values
boolean
required
custom_event_name
string | null
required
exposed_event_keys
string[]
required
created_at
string<date>
required
updated_at
string<date>
required