Tiers, tier trend, sunset policy and health per list

GET

/api/v1/workspaces/{workspace}/audience/health

package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/audience/health"

  req, _ := http.NewRequest("GET", url, nil)

  req.Header.Add("Authorization", "Bearer <token>")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

const url = 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/audience/health';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/audience/health \
  --header 'Authorization: Bearer <token>'

Permission: subscribers:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

/^[a-z0-9][a-z0-9-]{1,62}$/

Workspace slug

Responses

200

application/json

object

computedAt

string format: date-time

insight

object

text

required

string

policy

required

object

activeDays

required

integer format: int64

>= 1 <= 3650

atRiskDays

required

integer format: int64

>= 2 <= 3650

countMachineOpens

required

boolean

deleteAfter

required

boolean

deleteAfterMonths

required

integer format: int64

>= 1 <= 120

enabled

required

boolean

enabledAt

string

reengage

required

boolean

reengageAutomation

Name of the automation that sends it

string

stopAfterDays

required

integer format: int64

>= 1 <= 365

stopBroadcasts

required

boolean

sunsetDays

required

integer format: int64

>= 3 <= 3650

policyWeek

required

Index of the trend column when the policy started, -1 if none

integer format: int64

reengageFlowId

string

rows

required

Array<object>

object

bounceRate

number format: double

complaintHigh

required

boolean

complaintRate

number format: double

contacts

required

integer format: int64

health

required

Excellent, Good, Needs attention, Re-permission needed

string

healthTone

required

string

Allowed values: ok warn bad

humanOpens

number format: double

required

string

kind

required

string

Allowed values: list view

name

required

string

netGrowth

required

integer format: int64

tiers

required

object

active

required

integer format: int64

atRisk

required

integer format: int64

cooling

required

integer format: int64

sunset

required

integer format: int64

unsubRate

number format: double

thisWeek

required

object

enterDay

string

entering

required

Contacts entering Sunset

integer format: int64

stopDay

string

stopping

required

Contacts whose Broadcasts stop

integer format: int64

tiers

required

Array<object>

object

count

required

integer format: int64

deltaPts

number format: double

good

required

boolean

pct

required

Share of all contacts, percent

number format: double

tier

required

string

Allowed values: active cooling at_risk sunset

total

required

integer format: int64

trend

required

Array<object>

object

active

required

number format: double

atRisk

required

number format: double

cooling

required

number format: double

day

required

string format: date

sunset

required

number format: double

winBackRate

number format: double

Example

{
  "rows": [
    {
      "healthTone": "ok",
      "kind": "list"
    }
  ],
  "tiers": [
    {
      "tier": "active"
    }
  ]
}

default

Error

application/problem+json

object

code

Stable error code, e.g. permission_denied

string

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

Array<object>

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

helpers

Members who hold the missing permission

Array<string>

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

meta

object

key

additional properties

permission

The missing permission key

string

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}