Queue a communication coverage CSV export
Queues targets or rollups with normalized filters and selected recognized columns. Stores a private artifact owned by the requesting user and the exact permission fingerprint. The worker rechecks access before and after generation. Returns 200 with queued/export_id; poll status before download. Requires communications_coverage enabled (or the configured explicit environment opt-in), an active non-disabled user and communications_coverage_view. Program and donor-form access restrict every surface; mailbox quick links additionally require email_manager/manage_email. Requires permission: one of communications_coverage_view.
curl --request POST \
--url https://api.gratona.com/v1/admin/communications/coverage/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view_mode": "targets",
"target_type": "sponsorship_pair",
"rollup_type": "recipient",
"column_order": [
"Column Order.*"
],
"sort": {
"field": "severity",
"direction": "asc"
},
"filters": {
"source_types": [
"message_manager"
],
"program_ids": [
1
],
"target_statuses": [
"active"
],
"coverage_statuses": [
"welcome_gap"
],
"stale_days": 30,
"channels": [
"email"
],
"metric_mode": "written_coverage",
"active_donor_window_days": 1,
"household_mode": "person",
"assigned_admin_id": 1,
"include_transactional_context": true,
"include_broadcast_context": true,
"include_covered": true,
"unread_only": true,
"pending_approval_only": true,
"no_thread_only": true
}
}
'import requests
url = "https://api.gratona.com/v1/admin/communications/coverage/export"
payload = {
"view_mode": "targets",
"target_type": "sponsorship_pair",
"rollup_type": "recipient",
"column_order": ["Column Order.*"],
"sort": {
"field": "severity",
"direction": "asc"
},
"filters": {
"source_types": ["message_manager"],
"program_ids": [1],
"target_statuses": ["active"],
"coverage_statuses": ["welcome_gap"],
"stale_days": 30,
"channels": ["email"],
"metric_mode": "written_coverage",
"active_donor_window_days": 1,
"household_mode": "person",
"assigned_admin_id": 1,
"include_transactional_context": True,
"include_broadcast_context": True,
"include_covered": True,
"unread_only": True,
"pending_approval_only": True,
"no_thread_only": True
}
}
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({
view_mode: 'targets',
target_type: 'sponsorship_pair',
rollup_type: 'recipient',
column_order: ['Column Order.*'],
sort: {field: 'severity', direction: 'asc'},
filters: {
source_types: ['message_manager'],
program_ids: [1],
target_statuses: ['active'],
coverage_statuses: ['welcome_gap'],
stale_days: 30,
channels: ['email'],
metric_mode: 'written_coverage',
active_donor_window_days: 1,
household_mode: 'person',
assigned_admin_id: 1,
include_transactional_context: true,
include_broadcast_context: true,
include_covered: true,
unread_only: true,
pending_approval_only: true,
no_thread_only: true
}
})
};
fetch('https://api.gratona.com/v1/admin/communications/coverage/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/communications/coverage/export",
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([
'view_mode' => 'targets',
'target_type' => 'sponsorship_pair',
'rollup_type' => 'recipient',
'column_order' => [
'Column Order.*'
],
'sort' => [
'field' => 'severity',
'direction' => 'asc'
],
'filters' => [
'source_types' => [
'message_manager'
],
'program_ids' => [
1
],
'target_statuses' => [
'active'
],
'coverage_statuses' => [
'welcome_gap'
],
'stale_days' => 30,
'channels' => [
'email'
],
'metric_mode' => 'written_coverage',
'active_donor_window_days' => 1,
'household_mode' => 'person',
'assigned_admin_id' => 1,
'include_transactional_context' => true,
'include_broadcast_context' => true,
'include_covered' => true,
'unread_only' => true,
'pending_approval_only' => true,
'no_thread_only' => true
]
]),
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.gratona.com/v1/admin/communications/coverage/export"
payload := strings.NewReader("{\n \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\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.gratona.com/v1/admin/communications/coverage/export")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/communications/coverage/export")
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 \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Coverage export queued.",
"status": "queued",
"export_id": 42
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}Authorizations
Passport bearer token authentication for legacy admin sessions.
Body
Validated request fields for this operation.
View mode. Validation: sometimes, string; allowed values: targets, rollups.
targets, rollups "targets"
Target type. Validation: sometimes, string; allowed values: sponsorship_pair, donor, donor_program, all.
sponsorship_pair, donor, donor_program, all "sponsorship_pair"
Rollup type. Validation: sometimes, string; allowed values: recipient, program.
recipient, program "recipient"
Column order. Validation: sometimes, array, max:40.
40Column order item. Validation: string, max:120.
120Sort. Validation: sometimes, array.
Show child attributes
Show child attributes
Filters. Validation: sometimes, array.
Show child attributes
Show child attributes
curl --request POST \
--url https://api.gratona.com/v1/admin/communications/coverage/export \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"view_mode": "targets",
"target_type": "sponsorship_pair",
"rollup_type": "recipient",
"column_order": [
"Column Order.*"
],
"sort": {
"field": "severity",
"direction": "asc"
},
"filters": {
"source_types": [
"message_manager"
],
"program_ids": [
1
],
"target_statuses": [
"active"
],
"coverage_statuses": [
"welcome_gap"
],
"stale_days": 30,
"channels": [
"email"
],
"metric_mode": "written_coverage",
"active_donor_window_days": 1,
"household_mode": "person",
"assigned_admin_id": 1,
"include_transactional_context": true,
"include_broadcast_context": true,
"include_covered": true,
"unread_only": true,
"pending_approval_only": true,
"no_thread_only": true
}
}
'import requests
url = "https://api.gratona.com/v1/admin/communications/coverage/export"
payload = {
"view_mode": "targets",
"target_type": "sponsorship_pair",
"rollup_type": "recipient",
"column_order": ["Column Order.*"],
"sort": {
"field": "severity",
"direction": "asc"
},
"filters": {
"source_types": ["message_manager"],
"program_ids": [1],
"target_statuses": ["active"],
"coverage_statuses": ["welcome_gap"],
"stale_days": 30,
"channels": ["email"],
"metric_mode": "written_coverage",
"active_donor_window_days": 1,
"household_mode": "person",
"assigned_admin_id": 1,
"include_transactional_context": True,
"include_broadcast_context": True,
"include_covered": True,
"unread_only": True,
"pending_approval_only": True,
"no_thread_only": True
}
}
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({
view_mode: 'targets',
target_type: 'sponsorship_pair',
rollup_type: 'recipient',
column_order: ['Column Order.*'],
sort: {field: 'severity', direction: 'asc'},
filters: {
source_types: ['message_manager'],
program_ids: [1],
target_statuses: ['active'],
coverage_statuses: ['welcome_gap'],
stale_days: 30,
channels: ['email'],
metric_mode: 'written_coverage',
active_donor_window_days: 1,
household_mode: 'person',
assigned_admin_id: 1,
include_transactional_context: true,
include_broadcast_context: true,
include_covered: true,
unread_only: true,
pending_approval_only: true,
no_thread_only: true
}
})
};
fetch('https://api.gratona.com/v1/admin/communications/coverage/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/communications/coverage/export",
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([
'view_mode' => 'targets',
'target_type' => 'sponsorship_pair',
'rollup_type' => 'recipient',
'column_order' => [
'Column Order.*'
],
'sort' => [
'field' => 'severity',
'direction' => 'asc'
],
'filters' => [
'source_types' => [
'message_manager'
],
'program_ids' => [
1
],
'target_statuses' => [
'active'
],
'coverage_statuses' => [
'welcome_gap'
],
'stale_days' => 30,
'channels' => [
'email'
],
'metric_mode' => 'written_coverage',
'active_donor_window_days' => 1,
'household_mode' => 'person',
'assigned_admin_id' => 1,
'include_transactional_context' => true,
'include_broadcast_context' => true,
'include_covered' => true,
'unread_only' => true,
'pending_approval_only' => true,
'no_thread_only' => true
]
]),
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.gratona.com/v1/admin/communications/coverage/export"
payload := strings.NewReader("{\n \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\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.gratona.com/v1/admin/communications/coverage/export")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gratona.com/v1/admin/communications/coverage/export")
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 \"view_mode\": \"targets\",\n \"target_type\": \"sponsorship_pair\",\n \"rollup_type\": \"recipient\",\n \"column_order\": [\n \"Column Order.*\"\n ],\n \"sort\": {\n \"field\": \"severity\",\n \"direction\": \"asc\"\n },\n \"filters\": {\n \"source_types\": [\n \"message_manager\"\n ],\n \"program_ids\": [\n 1\n ],\n \"target_statuses\": [\n \"active\"\n ],\n \"coverage_statuses\": [\n \"welcome_gap\"\n ],\n \"stale_days\": 30,\n \"channels\": [\n \"email\"\n ],\n \"metric_mode\": \"written_coverage\",\n \"active_donor_window_days\": 1,\n \"household_mode\": \"person\",\n \"assigned_admin_id\": 1,\n \"include_transactional_context\": true,\n \"include_broadcast_context\": true,\n \"include_covered\": true,\n \"unread_only\": true,\n \"pending_approval_only\": true,\n \"no_thread_only\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"message": "Coverage export queued.",
"status": "queued",
"export_id": 42
}{
"message": "Unauthorized",
"status": "error"
}{
"message": "Not Found",
"status": "error"
}{
"errors": {},
"status": "error",
"message": "The given data was invalid."
}