Campaigns

Get campaign audience

Changed on

Resolves the campaign's stored targeting into named lists and segments and returns a recipient count computed at read time. When audience.isUnset is true the campaign has no targeting and scheduling sends to every active subscriber.

get/campaigns/{campaignId}/audience

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/campaigns/{campaignId}/audience
  • Auth
    HTTP bearer

Path parameters

campaignIdstring required

Campaign ID

Response

Resolved campaign audience

successboolean
campaignIdstring
campaignNamestring
statusstring
scheduledAtstring date-time nullable
recipientCountinteger

Subscribers matching the effective targeting right now.

targetListsobject nullable

Raw stored targeting exactly as persisted on the campaign.

Example response

{
  "success": true
}

Changes

  • db3873ca3d4dRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f1d8cfd9faafRevision changes
    • warning

      added the new undefined enum value to the / response property for the response status