Audiences API

Endpoints:


Get all audiences

Description: Returns all audiences/ segments within your account.
Endpoint: (GET) /audiences/:uid

Response body:

{
  "data": [
    {
      "aid": "1011",
      "avatar": "https://alpineiq.com/dashResources/templateIcons/8.png",
      "name": "CBD product buyers",
      "audienceSize": 392949,
      "optInSize": 7884,
      "status": 1,
      "editable": false,
      "archived": false,
      "cltv": 0
    },
    {
      "aid": "1012",
      "avatar": "https://alpineiq.com/dashResources/templateIcons/1.png",
      "name": "People that purchase atleast every 30 days",
      "audienceSize": 1353,
      "optInSize": 23,
      "status": 1,
      "editable": false,
      "archived": false,
      "cltv": 0
    },
  ]
}
FieldTypeDescription
aidstringAudience ID
avatarstringAvatar URL for audience
namestringName of audience
audienceSizeINTTotal people in this audience
optInSizeINTNumber of personas that are loyalty or member club members in this audience
statusboolWhether or not this audience is actively segmenting and calculating members
editableboolWhether or not you can edit this audience
archivedboolWhether or not the audience is archived
cltvINTCustomer lifetime value projection for this audience