Skip to main content
GET
/
broadcasts
cURL
curl --request GET \
  --url https://api.konvoai.com/broadcasts \
  --header 'x-api-key: <api-key>'
{
  "count": 123,
  "result": [
    {
      "id": "01823bbc-96e0-4c0a-a9cd-0a41ede22d50",
      "name": "Black Friday Campaign",
      "status": "Running",
      "audience": {
        "id": "1b03b3be-6aa4-4898-82ee-7db51b4ce28e",
        "name": "Black Friday Campaign - Audience",
        "broadcastId": "7b535c43-71b2-4b5e-b35e-f0b0f93bc84e",
        "lists": [
          "<any>"
        ],
        "segment": "null",
        "recipientCount": "2000"
      },
      "flow": {
        "id": "1b03b3be-6aa4-4898-82ee-7db51b4ce28e",
        "name": "Example Reactivation Flow",
        "emoji": "🏷️",
        "flowVersionId": "7b535c43-71b2-4b5e-b35e-f0b0f93bc84e"
      },
      "templates": "1b03b3be-6aa4-4898-82ee-7db51b4ce28e",
      "scheduled": "2024-08-T12:19:41.000Z",
      "createdAt": "2024-08-02T12:19:41.000Z",
      "sent": 0,
      "delivered": 0,
      "failed": 0,
      "opened": 0,
      "clickAnalytics": {
        "count": 0,
        "uniqueCount": 0,
        "countryCount": [
          {
            "count": 8,
            "countryCode": "DE",
            "resourceId": "u0IwaLEG1a"
          }
        ],
        "sendCount": 2000
      },
      "cost": {
        "amount": 0,
        "currency": "eur"
      }
    }
  ]
}

Authorizations

x-api-key
string
header
required

Query Parameters

page
integer

Pointer for the current page of the paginated query

limit
integer

The maximum number of results to return, maximum is 200

updated_at_min
string

Filter by broadcasts updated after a certain date

updated_at_max
string

Filter by broadcasts updated before a certain date

created_at_min
string

Filter by broadcasts created after a certain date

created_at_max
string

Filter by broadcasts created after a certain date

Response

Get broadcast response

count
integer

Total count of the request

result
object[]

Resulting query