Website › Posts, with their 30-day numbers

GET

/api/v1/workspaces/{workspace}/website/posts

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/website/posts?status=all&visibility=public&source=campaign"

  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/website/posts?status=all&visibility=public&source=campaign';
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/website/posts?status=all&visibility=public&source=campaign' \
  --header 'Authorization: Bearer <token>'

Permission: website:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

Query Parameters

status

A status (all by default)

string

Allowed values: all published scheduled draft unpublished ""

A status (all by default)

visibility

string

Allowed values: public members paid ""

tag

A tag’s id

string

A tag’s id

source

string

Allowed values: campaign web ""

Search by title

string

<= 200 characters

Search by title

page

integer format: int64

<= 10000

pageSize

integer format: int64

<= 100

Responses

200

application/json

object

counts

required

object

all

required

integer format: int64

draft

required

integer format: int64

fromCampaigns

required

integer format: int64

membersOnly

required

integer format: int64

paid

required

integer format: int64

published

required

integer format: int64

scheduled

required

integer format: int64

unpublished

required

integer format: int64

webOnly

required

integer format: int64

from

required

string format: date-time

page

required

integer format: int64

pageSize

required

integer format: int64

posts

required

Array<object>

object

approval

object

approvers

required

Array<string>

required

string

note

string

requestedAt

required

string format: date-time

requestedBy

required

string

rule

required

string

status

required

string

Allowed values: pending approved changes_requested rejected

byline

required

object

color

string

name

required

string

userId

string

campaign

object

required

string

name

required

string

scheduledAt

string format: date-time

sentAt

string format: date-time

status

required

string

createdBy

required

string

excerpt

required

string

featured

required

boolean

hasMarker

required

boolean

required

string

kind

required

string

Allowed values: campaign web

markerAfter

required

integer format: int64

neverFree

required

boolean

publishAt

string format: date-time

publishMode

required

string

Allowed values: with_send at now

publishTz

string

publishedAt

string format: date-time

redirectTo

string

signups

required

integer format: int64

slug

required

string

status

required

string

Allowed values: draft scheduled published unpublished

tags

required

Array<object>

object

required

string

name

required

string

slug

required

string

tiers

required

Array<object>

object

required

string

label

required

string

name

required

string

title

required

string

unpublishReason

string

unpublishedAt

string format: date-time

unpublishedBy

string

updatedAt

required

string format: date-time

upgrades

required

integer format: int64

url

required

string

views

required

integer format: int64

viewsAllTime

required

integer format: int64

visibility

required

string

Allowed values: public members paid

total

required

integer format: int64

until

required

string format: date-time

Example

{
  "posts": [
    {
      "approval": {
        "status": "pending"
      },
      "kind": "campaign",
      "publishMode": "with_send",
      "status": "draft",
      "visibility": "public"
    }
  ]
}

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