Get aggregated analytics by property

Query Parameters

fromstringdate

The start date of the custom date range. Defaults to 30 days ago if not specified.

---

throughstringdate

The to (inclusive) date of the custom date range. Defaults to the current date if not specified.

Returns

bundlearray of objectrequired

An array of objects describing a bundle's aggregated orders.

---

locationarray of objectrequired

An array of objects describing a location's aggregated orders.

---

registryarray of objectrequired

An array of objects describing a registry's aggregated orders.

---

oxford_offsetting_principlesarray of objectrequired

An array of objects describing aggregated orders for each Oxford Offsetting Principle's type.

---

offset_typearray of objectrequired

An array of objects describing aggregated orders by offset type.

GET /analytics/aggregated-by-property

curl 'https://api.lune.co/v1/analytics/aggregated-by-property' \
  -H 'Authorization: Bearer <API_KEY>'

Response

{
  "bundle": [
    {
      "bundle_id": "va1BEV2VZqnzPkYxJgALg0GeQDoXlWO5",
      "bundle_name": "Latin America Forestry",
      "quantity": "500.50",
      "value": "222.667"
    }
  ],
  "location": [
    {
      "location": "Europe",
      "quantity": "500.50",
      "value": "222.667"
    }
  ],
  "registry": [
    {
      "registry_name": "Verra",
      "quantity": "500.50",
      "value": "222.667"
    }
  ],
  "oxford_offsetting_principles": [
    {
      "type": 5,
      "quantity": "500.50",
      "value": "222.667"
    }
  ],
  "offset_type": [
    {
      "offset_type": "emissions_reduction",
      "quantity": "500.50",
      "value": "222.667"
    }
  ]
}