Aggregate records

curl --request POST \
  --url https://api.clearskies.cc/v1/objects/{object}/aggregate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "filters": [
    {
      "field": "closeDate",
      "op": "after",
      "value": "2026-01-01"
    }
  ],
  "groupBy": "stage",
  "metrics": [
    {
      "field": "amount",
      "function": "sum"
    },
    {
      "field": "amount",
      "function": "avg"
    }
  ]
}
'

import requests

url = "https://api.clearskies.cc/v1/objects/{object}/aggregate"

payload = {
    "filters": [
        {
            "field": "closeDate",
            "op": "after",
            "value": "2026-01-01"
        }
    ],
    "groupBy": "stage",
    "metrics": [
        {
            "field": "amount",
            "function": "sum"
        },
        {
            "field": "amount",
            "function": "avg"
        }
    ]
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    filters: [{field: 'closeDate', op: 'after', value: '2026-01-01'}],
    groupBy: 'stage',
    metrics: [{field: 'amount', function: 'sum'}, {field: 'amount', function: 'avg'}]
  })
};

fetch('https://api.clearskies.cc/v1/objects/{object}/aggregate', 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.clearskies.cc/v1/objects/{object}/aggregate",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'filters' => [
        [
                'field' => 'closeDate',
                'op' => 'after',
                'value' => '2026-01-01'
        ]
    ],
    'groupBy' => 'stage',
    'metrics' => [
        [
                'field' => 'amount',
                'function' => 'sum'
        ],
        [
                'field' => 'amount',
                'function' => 'avg'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.clearskies.cc/v1/objects/{object}/aggregate"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"after\",\n      \"value\": \"2026-01-01\"\n    }\n  ],\n  \"groupBy\": \"stage\",\n  \"metrics\": [\n    {\n      \"field\": \"amount\",\n      \"function\": \"sum\"\n    },\n    {\n      \"field\": \"amount\",\n      \"function\": \"avg\"\n    }\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.clearskies.cc/v1/objects/{object}/aggregate")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"after\",\n      \"value\": \"2026-01-01\"\n    }\n  ],\n  \"groupBy\": \"stage\",\n  \"metrics\": [\n    {\n      \"field\": \"amount\",\n      \"function\": \"sum\"\n    },\n    {\n      \"field\": \"amount\",\n      \"function\": \"avg\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.clearskies.cc/v1/objects/{object}/aggregate")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"filters\": [\n    {\n      \"field\": \"closeDate\",\n      \"op\": \"after\",\n      \"value\": \"2026-01-01\"\n    }\n  ],\n  \"groupBy\": \"stage\",\n  \"metrics\": [\n    {\n      \"field\": \"amount\",\n      \"function\": \"sum\"\n    },\n    {\n      \"field\": \"amount\",\n      \"function\": \"avg\"\n    }\n  ]\n}"

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

{
  "ok": true,
  "data": {
    "count": 15,
    "metrics": null,
    "groups": [
      {
        "value": "Negotiation",
        "count": 12,
        "metrics": [
          {
            "field": "amount",
            "function": "sum",
            "value": 864000
          },
          {
            "field": "amount",
            "function": "avg",
            "value": 72000
          }
        ]
      },
      {
        "value": null,
        "count": 3,
        "metrics": [
          {
            "field": "amount",
            "function": "sum",
            "value": 0
          },
          {
            "field": "amount",
            "function": "avg",
            "value": null
          }
        ]
      }
    ]
  },
  "requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "filters[0].op \"contains\" is not an operator \"createdAt\" accepts. Valid operators: equal, notEqual, before, after, isEmpty, isNotEmpty."
  },
  "requestId": "0199f2b0-7c41-7a3e-9d6c-2f5a1b8e4c07"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}

{
  "ok": false,
  "error": {
    "code": "BAD_REQUEST",
    "message": "<string>"
  },
  "requestId": "<string>",
  "traceId": "<string>"
}