Skip to main content
POST
Search communication coverage targets

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.

Response

Operation result.

data
object[]
meta
object
summary
object

Counts cover the permitted audience before coverage-status/work-queue filters; active_targets names the selected audience count even when inactive/archived statuses are selected.