---
title: "Preview a chat broadcast's reach"
method: GET
path: "/chat/broadcasts/preview"
tags: ["Chat"]
---

# Preview a chat broadcast's reach

`GET /chat/broadcasts/preview`

## Request

- Base URL: `https://viral.app/api/v1`
- URL: `https://viral.app/api/v1/chat/broadcasts/preview`
- Auth: API key in header `x-api-key`

Counts whom a broadcast to this audience would reach right now, without sending anything: the distinct creators it would message (`creators`, `campaigns`, `all`), or for `groups` the groups it would post in (`groupCount`) and the creators who can read them. Only creators who can receive messages count — they joined your organization or hold a pending invitation. Ids that are archived or not your organization's are ignored here.

## Query parameters

- `audience` 'creators' | 'campaigns' | 'all' | 'groups', required
- `orgCreatorIds` string[]
- `campaignIds` string[]
- `groupChatIds` string[]

## Response `200`

OK

- object
  - `recipientCount` integer, required
  - `groupCount` integer

## Other responses

- `400`: 400
- `401`: 401
- `402`: 402
- `404`: 404
- `408`: 408
- `429`: 429
- `500`: 500

---

[API](https://skmtc.dev/viral/apis/viral-app-api.md) · [All operations](https://skmtc.dev/viral/apis/viral-app-api/llms.txt) · [OpenAPI document](https://skmtc.dev/viral/apis/viral-app-api/revisions/31e97fa79ef1?raw)