Skip to content
ReputeCastReputeCast Docs

A program's results: the funnel, confirmed referrals over time, channels, top referrers, rewards and quality

GET
/api/v1/workspaces/{workspace}/grow/referrals/{program}/results
curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/grow/referrals/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/results?period=7d&grouping=day' \
  --header 'Authorization: Bearer <token>'

Permission: grow:view

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
workspace
required

Workspace slug

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

Workspace slug

program
required
string format: uuid

Query Parameters

Section titled “Query Parameters”
period
string
default: all
Allowed values: 7d 30d all
grouping
string
default: week
Allowed values: day week

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
channels
required
Array<object>
object
channel
required
string
Allowed values: copy x linkedin whatsapp email other
signups
required
integer format: int64
visits
required
integer format: int64
enough
required

20 confirmed referrals or more

boolean
from
required
string format: date-time
funnel
required
object
confirmed
required
integer format: int64
counted
required
integer format: int64
held
required
integer format: int64
holdEndsBy
string format: date-time
inHold
required
integer format: int64
notCounted
required
integer format: int64
reasons
required
Array<object>
object
count
required
integer format: int64
leftKind
required
string
reason
required
string
Allowed values: self same_ip disposable left already never_confirmed reviewer
referrers
required
integer format: int64
rewardsSent
required
integer format: int64
signups
required
integer format: int64
unconfirmed
required

Never confirmed, or still waiting to confirm

integer format: int64
visits
required
integer format: int64
weeks
required
integer format: int64
grouping
required
string
Allowed values: day week
overTime
required
Array<object>
object
confirmed
required
integer format: int64
days
required
integer format: int64
end
required
string format: date-time
partial
required
boolean
start
required
string format: date-time
period
required
string
Allowed values: 7d 30d all
program
required
object
announcedIn
required
string
awaiting
required
integer format: int64
counting
required
object
burst
required
object
on
required
boolean
threshold
required
integer format: int64
>= 1 <= 1000
disposable
required
boolean
holdDays
required
integer format: int64
Allowed values: 0 3 7 14 30
left
required
boolean
numbered
required
boolean
sameIp
required
boolean
sharedIp
required
object
on
required
boolean
threshold
required
integer format: int64
>= 1 <= 1000
emails
required
object
milestones
required
integer format: int64
on
required
integer format: int64
replyTo
required
string
senderId
required
string
held
required
integer format: int64
heldOldest
string format: date-time
helpers
required
object
connect
required
Array<string>
earn
required
Array<string>
edit
required
Array<string>
export
required
Array<string>
review
required
Array<string>
id
required
string
inHold
required
integer format: int64
leaderboard
required
object
at
string format: date-time
by
required
string
on
required
boolean
periods
required
Array<string>
<= 2 items
Allowed values: month all
rows
required
integer format: int64
Allowed values: 5 10 25
url
required
string
linkExample
required
string
linkHost
required
string
links
required
integer format: int64
listId
required
string
listName
required
string
pages
required
object
hubIntro
required
string
<= 600 characters
inviteHeadline
required
string
<= 200 characters
inviteText
required
string
<= 600 characters
shareButtons
required
Array<string>
<= 5 items
Allowed values: copy email x linkedin whatsapp
shareMessage
required
string
<= 500 characters
senders
required
Array<object>
object
default
required
boolean
email
required
string
id
required
string
name
required
string
verified
required
boolean
setupSavedAt
string format: date-time
setupSavedBy
required
string
setupStep
required
integer format: int64
startedAt
string format: date-time
startedBy
required
string
status
required
string
Allowed values: off on
statusAt
string format: date-time
statusBy
required
string
subscribers
required
integer format: int64
updatedAt
required
string format: date-time
quality
required
object
bounced
required
object
others
required
number format: double
othersN
required
integer format: int64
othersOf
required
integer format: int64
referred
required
number format: double
referredN
required
integer format: int64
referredOf
required
integer format: int64
campaign
required
string
enough
required
boolean
opens
required
object
others
required
number format: double
othersN
required
integer format: int64
othersOf
required
integer format: int64
referred
required
number format: double
referredN
required
integer format: int64
referredOf
required
integer format: int64
referred
required
integer format: int64
unsubscribed
required
object
others
required
number format: double
othersN
required
integer format: int64
othersOf
required
integer format: int64
referred
required
number format: double
referredN
required
integer format: int64
referredOf
required
integer format: int64
rewards
required
Array<object>
object
count
required
integer format: int64
failed
required
integer format: int64
milestoneId
required
string
name
required
string
reached
required
integer format: int64
sent
required
integer format: int64
type
required
string
used
required
integer format: int64
waiting
required
integer format: int64
to
required
string format: date-time
top
required
Array<object>
object
counted
required
integer format: int64
email
required
string
held
required
integer format: int64
inHold
required
integer format: int64
lastReferral
string format: date-time
linkId
required
string
milestones
required
Array<integer>
name
required
string
unclaimed
required
string
withTen
required
integer format: int64
withThree
required
integer format: int64

Example 

{
  "channels": [
    {
      "channel": "copy"
    }
  ],
  "funnel": {
    "reasons": [
      {
        "reason": "self"
      }
    ]
  },
  "grouping": "day",
  "period": "7d",
  "program": {
    "counting": {
      "holdDays": 0
    },
    "leaderboard": {
      "periods": [
        "month"
      ],
      "rows": 5
    },
    "pages": {
      "shareButtons": [
        "copy"
      ]
    },
    "status": "off"
  }
}

default

Section titled “default”

Error

Media typeapplication/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"
}
Report a problem with this pageReputeCast websiteHostReputeContent licensed under CC BY 4.0