Warm-up plans with their ramp, progress and log
GET
/api/v1/workspaces/{workspace}/warmup
package main
import ( "fmt" "net/http" "io")
func main() {
url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/warmup"
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/warmup';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/warmup \ --header 'Authorization: Bearer <token>'Permission: providers:view
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”workspace
required
Workspace slug
string
Workspace slug
Responses
Section titled “Responses”OK
Media typeapplication/json
object
candidates
required
Array<object>
object
ips
required
Array<string>
name
required
string
providerId
required
string
plans
required
Array<object>
object
bounceRate
number format: double
complaintRate
number format: double
createdBy
required
string
day
required
integer format: int64
days
required
integer format: int64
endDate
required
string format: date-time
id
required
string
ip
required
string
lastSlowdown
object
bounce
required
number format: double
day
required
integer format: int64
log
required
Array<object>
object
at
required
string format: date-time
body
required
string
kind
required
string
title
required
string
nextRate
object
day
required
integer format: int64
value
required
number format: double
plannedToDate
required
integer format: int64
progress
required
Percent of the plan’s days
number format: double
provider
required
string
providerId
required
string
rateToday
required
number format: double
schedule
required
Array<object>
object
bounce
number format: double
cap
required
integer format: int64
complaint
number format: double
date
required
string format: date-time
day
required
integer format: int64
eligible
required
boolean
held
required
boolean
plannedCap
required
integer format: int64
sent
integer format: int64
share
required
integer format: int64
shareChange
required
boolean
status
required
string
tiers
required
Array<string>
uses
required
Array<object>
object
count
required
integer format: int64
name
required
string
sentToday
required
integer format: int64
sentTotal
required
integer format: int64
settings
required
object
days
required
integer format: int64
engagedFirst
required
boolean
guardAction
required
string
guardBounce
required
number format: double
guardComplaint
required
number format: double
spreadMailbox
required
boolean
short
required
string
slowdowns
required
integer format: int64
startDate
required
string format: date-time
status
required
string
statusDetail
required
string
todayCap
required
integer format: int64
Example
{ "plans": [ { "schedule": [ { "status": "done" } ], "settings": { "days": 14, "guardAction": "hold" }, "status": "active" } ]}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
Example
{ "detail": "Property foo is required but is missing.", "instance": "https://example.com/error-log/abc123", "status": 400, "title": "Bad Request", "type": "about:blank"}