Grow's overview: the last 30 days' numbers, what needs a person, and new subscribers per week by source

GET

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

package main

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

func main() {

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

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

from

required

The period’s first day (workspace time zone)

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>

listId

required

string

listName

required

string

needsYou

required

Array<object>

object

required

string format: date-time

codesLeft

required

integer format: int64

count

required

integer format: int64

expires

required

Array<string>

kind

required

string

Allowed values: held partner_invalid partner_unreachable unclaimed codes_out codes_low webhook_failing to_fulfill stripe_missing file_missing

milestone

required

integer format: int64

milestoneId

required

string

partner

required

string

people

required

Array<object>

object

count

required

integer format: int64

name

required

string

reason

required

string

Allowed values: signature_rejected ended unknown_link ""

reward

required

string

since

string format: date-time

programId

required

string

programStart

string format: date-time

programStatus

required

string

Allowed values: on off ""

recommendedBy

required

integer format: int64

recommends

required

integer format: int64

tiles

required

object

confirmed

required

integer format: int64

conversion

required

Percent

number format: double

fromGrow

required

integer format: int64

newSubscribers

required

integer format: int64

partnerSignups

required

integer format: int64

partners

required

Array<string>

rewards

required

Array<object>

object

count

required

integer format: int64

milestone

required

integer format: int64

name

required

string

rewardsSent

required

integer format: int64

visits

required

integer format: int64

required

Today

string format: date-time

updatedAt

required

string format: date-time

weeks

required

Array<object>

object

days

required

integer format: int64

end

required

string format: date-time

other

required

Forms and other sources (imports left out)

integer format: int64

partial

required

The week is still going

boolean

partners

required

integer format: int64

referrals

required

integer format: int64

start

required

string format: date-time

Example

{
  "needsYou": [
    {
      "kind": "held",
      "reason": "signature_rejected"
    }
  ],
  "programStatus": "on"
}

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