Export a fundraising cohort bucket

GET

admin

fundraising

cohorts

{bucket}

export

Export a fundraising cohort bucket

curl --request GET \
  --url https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export', 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/fundraising/cohorts/{bucket}/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/fundraising/cohorts/{bucket}/export"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/fundraising/cohorts/{bucket}/export")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

<string>

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

bucket

string

required

Cohort bucket key. Only lost_donors permits reactivation.

Query Parameters

acknowledgement_work_scope

enum<string> | null

Acknowledgement work scope. Validation: nullable; allowed values: active, historical, all.

Available options:

active,

historical,

all,

null

fundraiser_user_id

string | null

Relationship-manager id, all or unassigned; scoped by donor visibility.

Maximum string length: 64

group_by_household

boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

string | null

Search. Validation: nullable, string, max:255.

Maximum string length: 255

date_from

string<date-time> | null

Date from. Validation: nullable, date.

date_to

string<date-time> | null

Date to. Validation: nullable, date.

state

string | null

State. Validation: nullable, string, max:64.

Maximum string length: 64

comparison_mode

string | null

Comparison mode. Validation: nullable, string, max:64.

Maximum string length: 64

current_start

string<date-time> | null

Current start. Validation: nullable, date.

current_end

string<date-time> | null

Current end. Validation: nullable, date.

comparison_start

string<date-time> | null

Comparison start. Validation: nullable, date.

comparison_end

string<date-time> | null

Comparison end. Validation: nullable, date.

refresh

boolean | null

Boolean-like query input; true/false and numeric forms are normalized by this workflow.

page

integer | null

Page. Validation: nullable, integer, min:1.

Required range: x >= 1

per_page

integer | null

Per page. Validation: nullable, integer, min:10, max:100.

Required range: 10 <= x <= 100

sort_field

enum<string> | null

Sort field. Validation: nullable; allowed values: donor_name, state, amount, current_amount, previous_amount, change_pct, gift_count, last_gift_date, relationship_manager_name, assigned_fundraiser_name.

Available options:

donor_name,

state,

amount,

current_amount,

previous_amount,

change_pct,

gift_count,

last_gift_date,

relationship_manager_name,

assigned_fundraiser_name,

null

sort_direction

enum<string> | null

Sort direction. Validation: nullable; allowed values: asc, desc.

Available options:

asc,

desc,

null

Response

Download generated file.

The response is of type file.

Export a fundraising cohort bucket

curl --request GET \
  --url https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.gratona.com/v1/admin/fundraising/cohorts/{bucket}/export', 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/fundraising/cohorts/{bucket}/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$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/fundraising/cohorts/{bucket}/export"

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

	req.Header.Add("Authorization", "Bearer <token>")

	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/fundraising/cohorts/{bucket}/export")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

<string>

{
  "message": "Unauthorized",
  "status": "error"
}

{
  "errors": {},
  "status": "error",
  "message": "The given data was invalid."
}