query BroadcastSendTargetRecipients($input: BroadcastSendTargetRecipientsInput!) {
broadcastSendTargetRecipients(input: $input) {
count
emptyReason
unsubscribedExcludedCount
recipients {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
cursor
node {
__typename
}
}
}
unsubscribedRecipients {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
cursor
node {
__typename
}
}
}
}
}{
"input": {
"type": "SLACK",
"sendTarget": {}
}
}{
"data": {
"broadcastSendTargetRecipients": {
"count": 1,
"emptyReason": "NO_TENANTS_MATCHED",
"unsubscribedExcludedCount": 1,
"recipients": {
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"__typename": "ConnectedSlackChannel"
}
}
]
},
"unsubscribedRecipients": {
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"__typename": "ConnectedSlackChannel"
}
}
]
}
}
}
}broadcastSendTargetRecipients
Who a send target resolves to right now. Takes the target rather than an id, so it answers for a filter still being written — before an audience is saved, or before a broadcast’s target is committed — as readily as for one about to be sent.
Point-in-time: the number moves as tenants, tiers and tenant fields change, and as channels are connected or disabled. Resolved through the same path a send uses, so it is what would actually be delivered to rather than an estimate assembled another way.
Resolves the target on every call. Requires the broadcast:read permission.
broadcastSendTargetRecipients(input: BroadcastSendTargetRecipientsInput!): BroadcastSendTargetRecipients!Arguments
Returns
Recipients resolved. Exact: there is no ceiling on what a target may resolve to.
Why count is zero. Null whenever it is not.
How many channels this target matched that were dropped because they unsubscribed. Does not change
count, which is who a send would reach. Zero when nobody among the matches has opted out.
The resolved recipients, in the order the count above counted them. searchQuery narrows these rows
by name without changing count, which is how large the audience is rather than how much of it is
being shown.
Channels the target matched that were dropped for unsubscribe. Same paging and search shape as
recipients. Does not change count or unsubscribedExcludedCount.
query BroadcastSendTargetRecipients($input: BroadcastSendTargetRecipientsInput!) {
broadcastSendTargetRecipients(input: $input) {
count
emptyReason
unsubscribedExcludedCount
recipients {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
cursor
node {
__typename
}
}
}
unsubscribedRecipients {
pageInfo {
hasPreviousPage
hasNextPage
startCursor
endCursor
}
edges {
cursor
node {
__typename
}
}
}
}
}{
"input": {
"type": "SLACK",
"sendTarget": {}
}
}{
"data": {
"broadcastSendTargetRecipients": {
"count": 1,
"emptyReason": "NO_TENANTS_MATCHED",
"unsubscribedExcludedCount": 1,
"recipients": {
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"__typename": "ConnectedSlackChannel"
}
}
]
},
"unsubscribedRecipients": {
"pageInfo": {
"hasPreviousPage": true,
"hasNextPage": true,
"startCursor": "string",
"endCursor": "string"
},
"edges": [
{
"cursor": "string",
"node": {
"__typename": "ConnectedSlackChannel"
}
}
]
}
}
}
}Was this page helpful?