Wrapped

Get organization's year in review

Retrieves wrapped statistics for a given year. For large datasets (>10,000 donations), * the calculation will be performed asynchronously when refresh=true. * * Polling Strategy: * 1. Make initial request with refresh=true * 2. If response is 202, begin polling the status endpoint * 3. Poll /wrapped/{year}/status every 5-10 seconds * 4. When status is 'completed', make another request to this endpoint * 5. Stop polling if status is 'failed' or after 5 minutes * * Example polling implementation: * ```javascript * async function getWrappedStats(year, refresh = false) { * const response = await fetch(`/api/v1/admin/wrapped/${year}?refresh=${refresh}`); * * if (response.status === 202) { * return pollCalculation(year); * } * * return response.json(); * } * * async function pollCalculation(year) { * let attempts = 0; * const maxAttempts = 60; // 5 minutes at 5-second intervals * * while (attempts < maxAttempts) { * const status = await fetch(`/api/v1/admin/wrapped/${year}/status`); * const data = await status.json(); * * if (data.status === 'completed') { * return getWrappedStats(year); * } * if (data.status === 'failed') { * throw new Error(data.error || 'Calculation failed'); * } * await new Promise(resolve => setTimeout(resolve, 5000)); * attempts++; * } * throw new Error('Calculation timed out'); * } * ```

GET

admin

wrapped

{year}

Get organization's year in review

curl --request GET \
  --url https://api.gratona.com/v1/admin/wrapped/{year} \
  --header 'X-HYS-API-Key: <api-key>'

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

fetch('https://api.gratona.com/v1/admin/wrapped/{year}', 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.gratona.com/v1/admin/wrapped/{year}",
  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-HYS-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.gratona.com/v1/admin/wrapped/{year}"

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

	req.Header.Add("X-HYS-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.gratona.com/v1/admin/wrapped/{year}")

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

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

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

{
  "metrics": {
    "overview": {
      "totalDonations": 1234,
      "totalAmount": 567890,
      "newDonors": 89,
      "avgDonation": 460
    },
    "monthly": [
      {
        "month": "2024-01",
        "donationCount": 123,
        "amount": 45000
      }
    ],
    "donorGrowth": {
      "newDonors": 89,
      "totalDonors": 500,
      "growthRate": 17.8
    },
    "programPerformance": [
      {
        "programId": 1,
        "programName": "Education Fund",
        "totalDonations": 150,
        "totalAmount": 75000,
        "commitments": {
          "total": 50,
          "active": 45,
          "pastDue": 3,
          "inactive": 2,
          "uniqueDonors": 40,
          "donorsWithoutCommitments": 10,
          "totalAmount": 25000,
          "annualizedAmount": 300000
        }
      }
    ],
    "retention": {
      "retentionRate": 75.5,
      "retainedDonors": 300,
      "previousYearDonors": 400,
      "currentYearDonors": 450
    },
    "topDonors": [
      {
        "donorId": 123,
        "donationCount": 5,
        "totalAmount": 25000,
        "name": "Anonymous"
      }
    ],
    "avgFillTime": 14.5
  },
  "descriptions": {
    "overview": {
      "title": "Your Year in Giving",
      "description": "<string>",
      "stats": {}
    },
    "donorGrowth": {
      "title": "Growing Together",
      "description": "<string>",
      "stats": {}
    },
    "retention": {
      "title": "Lasting Connections",
      "description": "<string>",
      "stats": {}
    },
    "monthly": {
      "title": "Monthly Impact",
      "description": "<string>",
      "stats": {}
    },
    "programPerformance": {
      "title": "Program Success",
      "description": "<string>",
      "stats": {}
    },
    "summary": {
      "title": "2024 Impact Story",
      "description": "<string>",
      "stats": {}
    }
  },
  "lastUpdated": "2023-11-07T05:31:56Z"
}

{
  "status": "reloading",
  "message": "Statistics are being recalculated. Please try again in a few minutes."
}

{
  "message": "Cannot generate wrapped for future years"
}

{
  "message": "Unauthenticated"
}

{
  "message": "Unauthorized"
}

{
  "message": "Error fetching wrapped data",
  "error": "Internal server error message"
}

Authorizations

X-HYS-API-Key

string

header

required

Gratona API key sent with the compatibility header X-HYS-API-Key.

Path Parameters

year

integer

required

Year to get wrapped data for. Must not be a future year. If not specified, defaults to current year. Any past year or current year

Example:

2024

Query Parameters

refresh

boolean

Force refresh of wrapped statistics. For large datasets (>10,000 donations), triggers async calculation.

Example:

false

Response

Successful operation

metrics

object

Show child attributes

descriptions

object

Show child attributes

lastUpdated

string<date-time>

Get organization's year in review

curl --request GET \
  --url https://api.gratona.com/v1/admin/wrapped/{year} \
  --header 'X-HYS-API-Key: <api-key>'

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

fetch('https://api.gratona.com/v1/admin/wrapped/{year}', 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.gratona.com/v1/admin/wrapped/{year}",
  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-HYS-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.gratona.com/v1/admin/wrapped/{year}"

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

	req.Header.Add("X-HYS-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.gratona.com/v1/admin/wrapped/{year}")

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

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

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

{
  "metrics": {
    "overview": {
      "totalDonations": 1234,
      "totalAmount": 567890,
      "newDonors": 89,
      "avgDonation": 460
    },
    "monthly": [
      {
        "month": "2024-01",
        "donationCount": 123,
        "amount": 45000
      }
    ],
    "donorGrowth": {
      "newDonors": 89,
      "totalDonors": 500,
      "growthRate": 17.8
    },
    "programPerformance": [
      {
        "programId": 1,
        "programName": "Education Fund",
        "totalDonations": 150,
        "totalAmount": 75000,
        "commitments": {
          "total": 50,
          "active": 45,
          "pastDue": 3,
          "inactive": 2,
          "uniqueDonors": 40,
          "donorsWithoutCommitments": 10,
          "totalAmount": 25000,
          "annualizedAmount": 300000
        }
      }
    ],
    "retention": {
      "retentionRate": 75.5,
      "retainedDonors": 300,
      "previousYearDonors": 400,
      "currentYearDonors": 450
    },
    "topDonors": [
      {
        "donorId": 123,
        "donationCount": 5,
        "totalAmount": 25000,
        "name": "Anonymous"
      }
    ],
    "avgFillTime": 14.5
  },
  "descriptions": {
    "overview": {
      "title": "Your Year in Giving",
      "description": "<string>",
      "stats": {}
    },
    "donorGrowth": {
      "title": "Growing Together",
      "description": "<string>",
      "stats": {}
    },
    "retention": {
      "title": "Lasting Connections",
      "description": "<string>",
      "stats": {}
    },
    "monthly": {
      "title": "Monthly Impact",
      "description": "<string>",
      "stats": {}
    },
    "programPerformance": {
      "title": "Program Success",
      "description": "<string>",
      "stats": {}
    },
    "summary": {
      "title": "2024 Impact Story",
      "description": "<string>",
      "stats": {}
    }
  },
  "lastUpdated": "2023-11-07T05:31:56Z"
}

{
  "status": "reloading",
  "message": "Statistics are being recalculated. Please try again in a few minutes."
}

{
  "message": "Cannot generate wrapped for future years"
}

{
  "message": "Unauthenticated"
}

{
  "message": "Unauthorized"
}

{
  "message": "Error fetching wrapped data",
  "error": "Internal server error message"
}