Communications

Search communication coverage rollups

Returns program groups by default, or recipient/program groups when rollup_type=recipient. Counts aggregate all permitted audience rows in each group; at least one row must match work filters. Defaults sort coverage_rate_30d ascending, independent of the target-list severity default. 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.

POST

admin

communications

coverage

rollups

Search communication coverage rollups

curl --request POST \
  --url https://api.gratona.com/v1/admin/communications/coverage/rollups/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_type": "sponsorship_pair",
  "rollup_type": "recipient",
  "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,
  "page": 1,
  "per_page": 1,
  "sort": {
    "field": "severity",
    "direction": "asc"
  }
}
'

import requests

url = "https://api.gratona.com/v1/admin/communications/coverage/rollups/search"

payload = {
    "target_type": "sponsorship_pair",
    "rollup_type": "recipient",
    "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,
    "page": 1,
    "per_page": 1,
    "sort": {
        "field": "severity",
        "direction": "asc"
    }
}
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({
    target_type: 'sponsorship_pair',
    rollup_type: 'recipient',
    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,
    page: 1,
    per_page: 1,
    sort: {field: 'severity', direction: 'asc'}
  })
};

fetch('https://api.gratona.com/v1/admin/communications/coverage/rollups/search', 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/rollups/search",
  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([
    'target_type' => 'sponsorship_pair',
    'rollup_type' => 'recipient',
    '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,
    'page' => 1,
    'per_page' => 1,
    'sort' => [
        'field' => 'severity',
        'direction' => 'asc'
    ]
  ]),
  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/rollups/search"

	payload := strings.NewReader("{\n  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\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/rollups/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/communications/coverage/rollups/search")

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  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\n  }\n}"

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

{
  "data": [
    {
      "rollup_type": "program",
      "program_id": 42,
      "entity_id": 42,
      "active_target_count": 1,
      "covered_target_count_30d": 1,
      "never_covered_target_count": 1,
      "only_context_target_count": 1,
      "stale_target_count_60d": 1,
      "pending_approval_count": 1,
      "unread_inbound_count": 1,
      "coverage_rate_30d": 0.5,
      "last_qualifying_touch_at": "2026-10-20 12:00:00",
      "matching_count": 1,
      "name": "Example",
      "program_name": "Example"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1
  }
}

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

{
  "message": "Not Found",
  "status": "error"
}

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

Authorizations

Authorization

string

header

required

Passport bearer token authentication for legacy admin sessions.

Body

application/json

Validated request fields for this operation.

target_type

enum<string>

Target type. Validation: sometimes, string; allowed values: sponsorship_pair, donor, donor_program, all.

Available options:

sponsorship_pair,

donor,

donor_program,

all

Example:

"sponsorship_pair"

rollup_type

enum<string>

Rollup type. Validation: sometimes, string; allowed values: recipient, program.

Available options:

recipient,

program

Example:

"recipient"

source_types

enum<string>[]

Source types. Validation: sometimes, array. Arrays also accept comma-separated strings.

Source types item. Validation: string; allowed values: message_manager, recipient_portal, mailing, newsletter, system_email.

Available options:

message_manager,

recipient_portal,

mailing,

newsletter,

system_email

program_ids

integer[]

Program ids. Validation: sometimes, array. Arrays also accept comma-separated strings.

Program ids item. Validation: integer, min:1.

Required range: x >= 1

target_statuses

enum<string>[]

Target statuses. Validation: sometimes, array. Arrays also accept comma-separated strings.

Target statuses item. Validation: string; allowed values: active, due, inactive, archived.

Available options:

active,

due,

inactive,

archived

coverage_statuses

enum<string>[]

Coverage statuses. Validation: sometimes, array. Arrays also accept comma-separated strings.

Coverage statuses item. Validation: string; allowed values: welcome_gap, never_covered, only_context, stale_30, stale_60, stale_90, covered.

Available options:

welcome_gap,

never_covered,

only_context,

stale_30,

stale_60,

stale_90,

covered

stale_days

enum<integer>

Stale days. Validation: sometimes, integer; allowed values: 30, 60, 90.

Available options:

30,

60,

90

Example:

30

channels

enum<string>[]

Channels. Validation: sometimes, array. Arrays also accept comma-separated strings.

Channels item. Validation: string; allowed values: email, print, sms, note.

Available options:

email,

print,

sms,

note

metric_mode

enum<string>

Accepted compatibility choice; this implementation computes written_coverage in either mode.

Available options:

written_coverage,

touchpoints_context

Example:

"written_coverage"

active_donor_window_days

integer

Donation-based eligibility window, default730days; affects donor and donor_program audience periods.

Required range: 1 <= x <= 3650

Example:

1

household_mode

enum<string>

Accepted compatibility choice; this implementation continues to project person-level targets.

Available options:

person,

household

Example:

"person"

assigned_admin_id

integer | null

Assigned admin id. Validation: nullable, integer, min:1.

Required range: x >= 1

Example:

1

include_transactional_context

boolean

Include transactional context. Validation: sometimes, boolean.

Example:

true

include_broadcast_context

boolean

Include broadcast context. Validation: sometimes, boolean.

Example:

true

include_covered

boolean

Include covered. Validation: sometimes, boolean.

Example:

true

unread_only

boolean

Unread only. Validation: sometimes, boolean.

Example:

true

pending_approval_only

boolean

Pending approval only. Validation: sometimes, boolean.

Example:

true

no_thread_only

boolean

No thread only. Validation: sometimes, boolean.

Example:

true

page

integer

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

Required range: x >= 1

Example:

1

per_page

integer

Per page. Validation: sometimes, integer, min:1, max:100.

Required range: 1 <= x <= 100

Example:

1

sort

object

Sort. Validation: sometimes, array.

Show child attributes

Response

Operation result.

data

object[]

Show child attributes

meta

object

Show child attributes

Search communication coverage rollups

curl --request POST \
  --url https://api.gratona.com/v1/admin/communications/coverage/rollups/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_type": "sponsorship_pair",
  "rollup_type": "recipient",
  "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,
  "page": 1,
  "per_page": 1,
  "sort": {
    "field": "severity",
    "direction": "asc"
  }
}
'

import requests

url = "https://api.gratona.com/v1/admin/communications/coverage/rollups/search"

payload = {
    "target_type": "sponsorship_pair",
    "rollup_type": "recipient",
    "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,
    "page": 1,
    "per_page": 1,
    "sort": {
        "field": "severity",
        "direction": "asc"
    }
}
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({
    target_type: 'sponsorship_pair',
    rollup_type: 'recipient',
    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,
    page: 1,
    per_page: 1,
    sort: {field: 'severity', direction: 'asc'}
  })
};

fetch('https://api.gratona.com/v1/admin/communications/coverage/rollups/search', 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/rollups/search",
  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([
    'target_type' => 'sponsorship_pair',
    'rollup_type' => 'recipient',
    '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,
    'page' => 1,
    'per_page' => 1,
    'sort' => [
        'field' => 'severity',
        'direction' => 'asc'
    ]
  ]),
  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/rollups/search"

	payload := strings.NewReader("{\n  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\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/rollups/search")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.gratona.com/v1/admin/communications/coverage/rollups/search")

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  \"target_type\": \"sponsorship_pair\",\n  \"rollup_type\": \"recipient\",\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  \"page\": 1,\n  \"per_page\": 1,\n  \"sort\": {\n    \"field\": \"severity\",\n    \"direction\": \"asc\"\n  }\n}"

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

{
  "data": [
    {
      "rollup_type": "program",
      "program_id": 42,
      "entity_id": 42,
      "active_target_count": 1,
      "covered_target_count_30d": 1,
      "never_covered_target_count": 1,
      "only_context_target_count": 1,
      "stale_target_count_60d": 1,
      "pending_approval_count": 1,
      "unread_inbound_count": 1,
      "coverage_rate_30d": 0.5,
      "last_qualifying_touch_at": "2026-10-20 12:00:00",
      "matching_count": 1,
      "name": "Example",
      "program_name": "Example"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 25,
    "total": 1
  }
}

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

{
  "message": "Not Found",
  "status": "error"
}

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