Held referrals grouped by referrer, with their evidence

GET

/api/v1/workspaces/{workspace}/grow/referrals/{program}/review

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review?signal=burst"

  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/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review?signal=burst';
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/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/review?signal=burst' \
  --header 'Authorization: Bearer <token>'

Permission: grow:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

program

required

string format: uuid

Query Parameters

signal

string

Allowed values: burst shared_ip numbered ""

referrer

string format: uuid

Responses

200

application/json

object

groups

required

Array<object>

object

confirmedDays

required

Array<string>

days

required

integer format: int64

differentNames

required

boolean

engaged

required

boolean

holdEnds

required

Array<string>

items

required

Array<object>

object

confirmedAt

string format: date-time

email

required

string

engagement

required

object

clicks

required

integer format: int64

joinedAfter

required

string

opened

required

Array<string>

short

required

Array<string>

holdEnds

string format: date-time

required

string

required

string

network

required

object

asn

required

string

cidr

required

string

kind

required

string

Allowed values: hosting office residential mobile ""

name

required

string

signals

required

Array<string>

signedUpAt

required

string format: date-time

opened

required

integer format: int64

openedIn

required

string

referrer

required

object

contactId

required

string

counted

required

integer format: int64

email

required

string

firstName

required

string

linkId

required

string

linkStatus

required

string

Allowed values: active paused

name

required

string

since

On the program’s list since

string format: date-time

sameDomain

required

string

signals

required

Array<object>

object

all

required

boolean

count

required

integer format: int64

first

required

string

from

string format: date-time

required

string

kind

required

string

Allowed values: burst shared_ip numbered

last

required

string

minutes

required

integer format: int64

network

required

object

asn

required

string

cidr

required

string

kind

required

string

Allowed values: hosting office residential mobile ""

name

required

string

threshold

required

integer format: int64

string format: date-time

suggestion

required

string

Allowed values: dont_pause count ""

held

required

integer format: int64

helpers

required

object

connect

required

Array<string>

earn

required

Array<string>

edit

required

Array<string>

export

required

Array<string>

review

required

Array<string>

holdDays

required

integer format: int64

oldest

string format: date-time

referrers

required

Array<object>

object

count

required

integer format: int64

linkId

required

string

name

required

string

showAddresses

required

boolean

signals

required

Array<object>

object

kind

required

string

referrers

required

integer format: int64

Example

{
  "groups": [
    {
      "items": [
        {
          "network": {
            "kind": "hosting"
          }
        }
      ],
      "referrer": {
        "linkStatus": "active"
      },
      "signals": [
        {
          "kind": "burst",
          "network": {
            "kind": "hosting"
          }
        }
      ],
      "suggestion": "dont_pause"
    }
  ]
}

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