A contact's score: its band, the breakdown by rule, the last change, the 90-day line and where it counts

GET

/api/v1/workspaces/{workspace}/contacts/{contact}/score

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/score"

  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/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/score';
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/contacts/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/score \
  --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

contact

required

string format: uuid

Responses

200

application/json

object

band

required

string

Allowed values: cold warm hot

bandSince

string format: date-time

bands

required

object

hotFrom

required

integer format: int64

>= 2 <= 100

warmFrom

required

integer format: int64

>= 1 <= 99

breakdown

required

Array<object>

object

atMax

required

boolean

capReached

string format: date-time

count

required

integer format: int64

formName

string

latest

string format: date-time

listName

string

number

required

The rule’s number on Scoring

integer format: int64

points

required

integer format: int64

rule

required

object

cap

required

object

kind

required

string

Allowed values: none once once_day once_week once_month points_day points_week points_month while_true

points

integer format: int64

<= 1000

contains

string

<= 200 characters

enabled

required

boolean

event

string

<= 100 characters

field

string

<= 64 characters

formId

string

<= 40 characters

required

Kept across versions; new rules get one when saved

string

<= 40 characters

kind

required

string

Allowed values: open click form api_event soft_bounce unsubscribe field

listId

string

<= 40 characters

string

Allowed values: is_one_of is_not is_set

points

required

integer format: int64

>= -50 <= 50

values

Array<string>

<= 20 items

zeroAt

string format: date-time

zeroEmail

string

configured

required

boolean

decay

required

object

enabled

required

boolean

lastActivity

string format: date-time

lastActivityKind

Open or click

string

lastOpen

string format: date-time

lost

required

integer format: int64

quietWeeks

required

integer format: int64

joinedAt

required

string format: date-time

lastChange

object

after

required

integer format: int64

afterBand

required

string

Allowed values: cold warm hot

required

string format: date-time

before

required

integer format: int64

beforeBand

required

string

Allowed values: cold warm hot

cause

required

object

emailName

string

eventName

string

formName

string

kind

required

string

Allowed values: open click form api_event soft_bounce unsubscribe decay

linkLabel

string

listName

string

url

string

delta

required

integer format: int64

line

required

Array<object>

object

day

required

YYYY-MM-DD in the workspace timezone

string

score

integer format: int64

recalculating

required

boolean

score

required

integer format: int64

uses

required

Array<object>

object

crossedAt

string format: date-time

direction

string

href

string

required

string

required

boolean

kind

required

string

Allowed values: segment automation block

liveSince

string format: date-time

name

required

string

threshold

integer format: int64

Example

{
  "band": "cold",
  "breakdown": [
    {
      "rule": {
        "cap": {
          "kind": "none"
        },
        "kind": "open",
        "op": "is_one_of"
      }
    }
  ],
  "lastChange": {
    "afterBand": "cold",
    "beforeBand": "cold",
    "cause": {
      "kind": "open"
    }
  },
  "uses": [
    {
      "kind": "segment"
    }
  ]
}

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"
}