What you recommend, who recommends you, where recommendations show and your partner profile

GET

/api/v1/workspaces/{workspace}/grow/recommendations

package main

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

func main() {

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

  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/recommendations';
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/recommendations \
  --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

Responses

200

application/json

object

blockShows

required

integer format: int64

blocks

required

Array<object>

object

automation

required

string

automationId

required

string

emailId

required

string

name

required

string

codes

required

Array<object>

object

createdAt

required

string format: date-time

createdBy

required

string

dailyLimit

required

integer format: int64

expiresAt

required

string format: date-time

required

string

label

required

string

listName

required

string

confirmPage

required

boolean

confirmShows

required

Array<string>

helpers

required

object

connect

required

Array<string>

earn

required

Array<string>

edit

required

Array<string>

export

required

Array<string>

review

required

Array<string>

items

required

Array<object>

object

clicks

required

integer format: int64

confirmed

required

integer format: int64

connectedAt

string format: date-time

connectedBy

required

string

dailyLimit

required

integer format: int64

description

required

string

hidden

required

boolean

host

required

string

required

string

initials

required

string

invalidReason

required

string

Allowed values: signature_rejected ended unknown_link ""

kind

required

string

Allowed values: link partner

limitUntil

string format: date-time

linkId

required

string

logo

object

required

string

name

required

string

url

required

string

name

required

string

pausedBy

required

string

position

required

integer format: int64

requests

required

integer format: int64

showBlock

required

boolean

showConfirm

required

boolean

shown

required

integer format: int64

shownConfirm

required

integer format: int64

shownEmail

required

integer format: int64

since

string format: date-time

state

required

string

Allowed values: showing paused connected partner_paused invalid limit unreachable ended

today

required

integer format: int64

url

required

string

waiting

required

integer format: int64

lists

required

Array<object>

object

required

string

name

required

string

subscribers

required

integer format: int64

pageUrl

required

string

profile

required

object

description

required

string

initials

required

string

instance

required

string

listId

required

string

listName

required

string

listSubscribers

required

integer format: int64

logo

object

required

string

name

required

string

url

required

string

name

required

string

recommendingYou

required

Array<object>

object

confirmed

required

integer format: int64

connectedBy

required

string

dailyLimit

required

integer format: int64

instance

required

string

label

required

string

linkId

required

string

listName

required

string

name

required

string

pausedAt

string format: date-time

pausedBy

required

string

requests

required

integer format: int64

since

required

string format: date-time

state

required

string

Allowed values: connected paused partner_paused invalid

today

required

integer format: int64

Example

{
  "items": [
    {
      "invalidReason": "signature_rejected",
      "kind": "link",
      "state": "showing"
    }
  ],
  "recommendingYou": [
    {
      "state": "connected"
    }
  ]
}

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