Skip to content
ReputeCastReputeCast Docs

Push setup: keys, sites, subscribers and prompts

GET
/api/v1/workspaces/{workspace}/push/setup
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/push/setup \
  --header 'Authorization: Bearer <token>'

Permission: providers:view

The private key is never returned.

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canEditPrompts
required
boolean
canManage
required
boolean
cap
required
integer format: int64
checkedAt
string format: date-time
helpers
required
Array<string>
keys
object
contact
required
string
createdAt
required
string format: date-time
createdBy
required
string
lastAcceptedAt
string format: date-time
publicKey
required
string
month
required
object
campaigns
required
integer format: int64
month
required
string format: date-time
sent
required
integer format: int64
shownPct
required
number format: double
on
required
boolean
prompts
required
Array<object>
object
config
required
object
allow
required
string
<= 30 characters
askAgainDays
required
integer format: int64
>= 1 <= 365
corner
string
Allowed values: bottom_right bottom_left ""
ios
required
string
Allowed values: steps hidden
message
required
string
<= 160 characters
notNow
required
string
<= 30 characters
pages
required
string
Allowed values: all_except only
paths
required
Array<string>
<= 20 items
style
required
string
Allowed values: bar dialog bell
title
required
string
<= 60 characters
when
required
object
button
required
boolean
posts
required
object
n
required
integer format: int64
<= 10000
on
required
boolean
scroll
required
object
n
required
integer format: int64
<= 10000
on
required
boolean
seconds
required
object
n
required
integer format: int64
<= 10000
on
required
boolean
formId
required
string
name
required
string
site
required
string
stats
required
object
allowed
required
integer format: int64
allowedPct
required
number format: double
bellClicked
required
integer format: int64
blocked
required
integer format: int64
closed
required
integer format: int64
closedPct
required
number format: double
granted
required
integer format: int64
grantedPct
required
number format: double
iosAdded
required
integer format: int64
iosAddedPct
required
number format: double
iosSteps
required
integer format: int64
iosSubscribers
required
integer format: int64
notNow
required
integer format: int64
notNowPct
required
number format: double
shown
required
integer format: int64
since
required
string format: date-time
sinceSnippet
required
boolean
status
required
string
Allowed values: draft live paused
version
required
integer format: int64
quiet
required
boolean
sites
required
Array<object>
object
addedAt
required
string format: date-time
addedBy
required
string
demo
required
boolean
host
required
string
iconUrl
string
id
required
string
kind
required
string
Allowed values: publication snippet
label
required
string
linked
required
integer format: int64
origin
required
string
prompts
required
Array<object>
object
formId
required
string
liveSince
string format: date-time
name
required
string
status
required
string
Allowed values: draft live paused
style
required
string
Allowed values: bar dialog bell
snippetSeenAt
string format: date-time
subscribers
required
integer format: int64
worker
required
object
checkedAt
string format: date-time
current
required
integer format: int64
detail
string
httpStatus
integer format: int64
mode
required
string
Allowed values: file import
path
required
string
scope
required
string
status
required
string
Allowed values: built_in found old_version missing unreachable not_a_worker unchecked
url
required
string
version
integer format: int64
snippet
required
object
importUrl
required
string
script
required
string
workerBytes
required
integer format: int64
workerFile
required
string
workerUrl
required
string
workerVersion
required
integer format: int64
subscribers
required
object
anonymous
required
integer format: int64
byBrowser
required
Array<object>
object
count
required
integer format: int64
key
required
string
bySite
required
Array<object>
object
count
required
integer format: int64
key
required
string
highlight
object
count
required
integer format: int64
listId
required
string
name
required
string
linked
required
integer format: int64
total
required
integer format: int64
website
string
window
required
string

Example 

{
  "prompts": [
    {
      "config": {
        "corner": "bottom_right",
        "ios": "steps",
        "pages": "all_except",
        "style": "bar"
      },
      "status": "draft"
    }
  ],
  "sites": [
    {
      "kind": "publication",
      "prompts": [
        {
          "status": "draft",
          "style": "bar"
        }
      ],
      "worker": {
        "mode": "file",
        "status": "built_in"
      }
    }
  ]
}

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