Fetch resource

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/resources/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/resources/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/resources/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/resources/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Emails sent",
  "type": "unit",
  "aggregation": "sum",
  "aggregateByField": "value",
  "billingModel": "in_full",
  "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filters": [
    {
      "property": "eventName",
      "value": "email_sent"
    },
    {
      "property": "type",
      "value": "certsign"
    },
    {
      "property": "type",
      "value": "certisign"
    }
  ],
  "archivedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "too_many_reads_in_flight"
}

GET

resources

{id}

Fetch resource

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

const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>'}};

fetch('https://api.useaira.com/v1/resources/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.useaira.com/v1/resources/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.useaira.com/v1/resources/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-KEY", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.useaira.com/v1/resources/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "Emails sent",
  "type": "unit",
  "aggregation": "sum",
  "aggregateByField": "value",
  "billingModel": "in_full",
  "itemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "filters": [
    {
      "property": "eventName",
      "value": "email_sent"
    },
    {
      "property": "type",
      "value": "certsign"
    },
    {
      "property": "type",
      "value": "certisign"
    }
  ],
  "archivedAt": "2023-11-07T05:31:56Z"
}

{
  "message": "<string>"
}

{
  "message": "<string>",
  "code": "too_many_reads_in_flight"
}

Authorizations

X-API-KEY

string

header

required

API Key Authentication.

Path Parameters

string<uuid>

required

The unique identifier of the resource in our system.

Response

Schema representing a resource.

string<uuid>

required

The unique identifier of the resource in our system.

name

string

required

The name of the resource.

Example:

"Emails sent"

type

enum<string>

required

The type of the resource.

Available options:

unit,

currency

aggregation

enum<string>

required

The aggregation method used for this resource.

Available options:

sum,

last_during_period,

unique

aggregateByField

string

required

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

Example:

"value"

billingModel

enum<string>

required

The billing model for this resource.

Available options:

in_full,

proration

itemId

string<uuid>

required

The related item identifier for this resource.

filters

object[]

required

The filters selecting the events this resource counts. Conditions repeated for the same property match if ANY condition matches (OR); different properties must ALL match (AND). At least one filter must use the property eventName.

Show child attributes

Example:

[
  {
    "property": "eventName",
    "value": "email_sent"
  },
  { "property": "type", "value": "certsign" },
  { "property": "type", "value": "certisign" }
]

archivedAt

string<date-time> | null

required

The timestamp when the resource was archived, or null if not archived.