Skip to content
ReputeCastReputeCast Docs

Joins and departures by source, quality by source, UTM and referring pages, and cohort retention

GET
/api/v1/workspaces/{workspace}/growth
curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/growth?period=30d' \
  --header 'Authorization: Bearer <token>'

Permission: subscribers: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

Query Parameters

Section titled “Query Parameters”
period

30d (default), 90d, 12m or custom

string
Allowed values: 30d 90d 12m custom ""

30d (default), 90d, 12m or custom

from

First day of a custom period (YYYY-MM-DD)

string
<= 10 characters

First day of a custom period (YYYY-MM-DD)

to

Last day of a custom period

string
<= 10 characters

Last day of a custom period

list

A list id: count its members instead of contacts

string

A list id: count its members instead of contacts

imports
boolean
cohortSource
string
<= 200 characters

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
chart
required
object
days
required
Array<object>
object
day
required
string
imports
required
integer format: int64
joined
required
Array<integer>
left
required
Array<integer>
series
required
Array<object>
object
joined
required
integer format: int64
key
required
string
left
required
integer format: int64
other
required
boolean
source
required
object
carried
string
carriedLabel
string
firstJoin
string format: date-time
formKind
string
hosts
required
Array<string>
importCount
integer format: int64
imported
required
boolean
importedAt
string format: date-time
integration
string
key
required
string
keyPrefix
string
kind
required
string
listChoice
boolean
name
required
string
tookImportDay
integer format: int64
url
string
workflow
string
cohortSource
required
string
cohortSources
required
Array<object>
object
carried
string
carriedLabel
string
firstJoin
string format: date-time
formKind
string
hosts
required
Array<string>
importCount
integer format: int64
imported
required
boolean
importedAt
string format: date-time
integration
string
key
required
string
keyPrefix
string
kind
required
string
listChoice
boolean
name
required
string
tookImportDay
integer format: int64
url
string
workflow
string
cohorts
required
Array<object>
object
after30
required
object
completeOn
string
from
string
rate
number format: double
state
required
string
Allowed values: done in_progress not_started
after90
required
object
completeOn
string
from
string
rate
number format: double
state
required
string
Allowed values: done in_progress not_started
contacts
required
integer format: int64
month
required

YYYY-MM

string
contacts
required
integer format: int64
departures
required
object
complained
required
integer format: int64
erased
required
integer format: int64
hardBounced
required
integer format: int64
unsubscribed
required
integer format: int64
flagFactor
required
number format: double
imports
required

Every finished import, for the only-imports state

Array<object>
object
count
required
integer format: int64
day
required
string
key
required
string
name
required
string
includeImports
required
boolean
list
object
id
required
string
name
required
string
lists
required
Array<object>
object
id
required
string
name
required
string
members
required
boolean
minContacts
required
integer format: int64
minDelivered
required
integer format: int64
onlyImports
required
boolean
period
required
object
days
required
integer format: int64
from
required

YYYY-MM-DD

string
kind
required
string
Allowed values: 30d 90d 12m custom
to
required

YYYY-MM-DD

string
referrers
required
object
joins
required
integer format: int64
none
required
integer format: int64
other
required
object
count
required
integer format: int64
humanOpenRate
number format: double
joins
required
integer format: int64
rows
required
Array<object>
object
joins
required
integer format: int64
page
required
string
sources
required
Array<object>
object
bounceFlag
number format: double
bounceRate
number format: double
complaintFlag
number format: double
complaintRate
number format: double
contacts
required
integer format: int64
delivered
required
integer format: int64
humanOpenRate
number format: double
joined
integer format: int64
left
required
integer format: int64
net
integer format: int64
sent
required
integer format: int64
source
required
object
carried
string
carriedLabel
string
firstJoin
string format: date-time
formKind
string
hosts
required
Array<string>
importCount
integer format: int64
imported
required
boolean
importedAt
string format: date-time
integration
string
key
required
string
keyPrefix
string
kind
required
string
listChoice
boolean
name
required
string
tookImportDay
integer format: int64
url
string
workflow
string
tooFew
string
Allowed values: contacts messages ""
tiles
required
object
importItems
required
Array<object>
object
count
required
integer format: int64
day
required
string
key
required
string
name
required
string
imports
required
integer format: int64
joined
required
integer format: int64
left
required
integer format: int64
net
required
integer format: int64
netPct
required
number format: double
total
required
object
joined
required
integer format: int64
left
required
integer format: int64
net
required
integer format: int64
utm
required
object
captureStartedAt
string format: date-time
captured
required
integer format: int64
joins
required
integer format: int64
none
required
object
campaign
required
string
humanOpenRate
number format: double
joins
required
integer format: int64
medium
required
string
source
required
string
notCaptured
required
integer format: int64
notCapturedHumanOpenRate
number format: double
other
required
object
count
required
integer format: int64
humanOpenRate
number format: double
joins
required
integer format: int64
rows
required
Array<object>
object
campaign
required
string
humanOpenRate
number format: double
joins
required
integer format: int64
medium
required
string
source
required
string
workspace
required
object
bounce
required
number format: double
complaint
required
number format: double
delivered
required
integer format: int64
humanOpen
required
number format: double
sent
required
integer format: int64

Example 

{
  "cohorts": [
    {
      "after30": {
        "state": "done"
      },
      "after90": {
        "state": "done"
      }
    }
  ],
  "period": {
    "kind": "30d"
  },
  "sources": [
    {
      "tooFew": "contacts"
    }
  ]
}

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