List resources

GET

resources

List resources

curl --request GET \
  --url https://api.useaira.com/v1/resources/ \
  --header 'X-API-KEY: <api-key>'

{
  "items": [
    {
      "id": "<string>",
      "name": "Emails sent",
      "type": "unit",
      "aggregation": "sum",
      "aggregateByField": "value",
      "customFields": {
        "customField1": "value1",
        "customField2": [
          "value2",
          "value3"
        ]
      },
      "filters": [
        {
          "property": "eventName",
          "value": "email_sent"
        }
      ]
    }
  ],
  "hasMore": true
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Query Parameters

offset

number

default:0

Required range: x >= 0

limit

number

default:100

required

Required range: 1 <= x <= 100

Response

200 - application/json

Default Response

items

object[]

required

A list of items.

Show child attributes

items.id

string

required

The unique identifier of the resource in our system.

items.name

string

required

The name of the resource.

Example:

"Emails sent"

items.type

enum<string>

required

The type of the resource.

Available options:

unit,

currency

items.aggregation

enum<string>

required

The aggregation method used for this resource.

Available options:

sum,

last_during_period,

unique

items.aggregateByField

string

required

The aggregateByField property indicates which field will be considered when aggregating events.

Example:

"value"

items.customFields

object

required

Custom fields that can be associated with the entity. The fields must be previously created in the system before they can be used.

Show child attributes

items.customFields.{key}

Example:

{
  "customField1": "value1",
  "customField2": ["value2", "value3"]
}

items.filters

object[]

required

The filters used for this resource.

Show child attributes

items.filters.property

string

The property of the filter.

items.filters.value

string

The value of the filter.

Example:

[
  {
    "property": "eventName",
    "value": "email_sent"
  }
]

hasMore

boolean

required

Indicates if there are more items to fetch.

Fetch resourceThis endpoint allows fetching a resource by id.

⌘I

List resources

curl --request GET \
  --url https://api.useaira.com/v1/resources/ \
  --header 'X-API-KEY: <api-key>'

{
  "items": [
    {
      "id": "<string>",
      "name": "Emails sent",
      "type": "unit",
      "aggregation": "sum",
      "aggregateByField": "value",
      "customFields": {
        "customField1": "value1",
        "customField2": [
          "value2",
          "value3"
        ]
      },
      "filters": [
        {
          "property": "eventName",
          "value": "email_sent"
        }
      ]
    }
  ],
  "hasMore": true
}

Conheça a Aira

Conceitos Essenciais

Referência da API

List resources

Authorizations

Query Parameters

Response