Skip to content
ReputeCastReputeCast Docs

Placement tests, newest first, with results per provider

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

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

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
attention
required
Array<object>
object
addedAt
required
string format: date-time
addedBy
required
string
auth
required
string
Allowed values: password oauth
checkedAt
string format: date-time
company
required
string
email
required
string
folders
required
Array<object>
object
label
required
string
name
required
string
role
required
string
Allowed values: inbox tab spam
host
string
id
required
string
lastTest
string
lastTestId
string
lastUsedAt
string format: date-time
passwordLabel
required
string
port
integer format: int64
provider
required
string
Allowed values: gmail google_workspace outlook microsoft_365 yahoo aol icloud gmx webde
providerName
required
string
status
required
string
Allowed values: connected expired failed unchecked
statusAt
string format: date-time
username
string
canManage
required
boolean
canRun
required
boolean
deleteAfter
required
string
Allowed values: 24h finished never
manageHelpers
required
Array<string>
providers
required
Array<object>
object
id
required
string
name
required
string
runHelpers
required
Array<string>
seedsConnected
required
integer format: int64
seedsTotal
required
integer format: int64
starters
required
Array<object>
object
id
required
string
name
required
string
tests
required
Array<object>
object
contentAt

When the campaign is scheduled or was sent

string format: date-time
contentId
string
contentKey
string
contentKind
required
string
Allowed values: campaign template digest transactional
contentName
required
string
contentNote
required

Draft, scheduled, sent, template or the transactional template’s key

string
contentVersion
integer format: int64
counts
required
object
copies
required
integer format: int64
failed
required
integer format: int64
found
required
integer format: int64
inbox
required
integer format: int64
notArrived
required
integer format: int64
notChecked
required
integer format: int64
notCheckedSeeds
required
Array<object>
object
email
required
string
name
required

The seed’s mailbox provider (iCloud)

string
provider
required
string
reason
required
string
Allowed values: signin_failed signin_expired seed_removed stopped unsent
spam
required
integer format: int64
tab
required
integer format: int64
tabs
required
Array<string>
unsent
required
integer format: int64
waiting
required
integer format: int64
finishedAt
string format: date-time
id
required
string
lastSentAt
string format: date-time
lateUntil

Late copies found until then update the result

string format: date-time
name
required
string
origin
required
string
Allowed values: placement review composer warmup template
personalization
required
string
providers
required
Array<object>
object
adapter
required
string
auth
required
object
checked
required
integer format: int64
dkim
required
object
fail
required
integer format: int64
pass
required
integer format: int64
dkimDomain
string
dkimSelector
string
dmarc
required
object
fail
required
integer format: int64
pass
required
integer format: int64
spf
required
object
fail
required
integer format: int64
pass
required
integer format: int64
spfDomain
string
color
required
string
cost
required
number format: double
counts
required
object
copies
required
integer format: int64
failed
required
integer format: int64
found
required
integer format: int64
inbox
required
integer format: int64
notArrived
required
integer format: int64
notChecked
required
integer format: int64
notCheckedSeeds
required
Array<object>
object
email
required
string
name
required

The seed’s mailbox provider (iCloud)

string
provider
required
string
reason
required
string
Allowed values: signin_failed signin_expired seed_removed stopped unsent
spam
required
integer format: int64
tab
required
integer format: int64
tabs
required
Array<string>
unsent
required
integer format: int64
waiting
required
integer format: int64
detail
required
string
fastest
object
folder
required
string
Allowed values: inbox tab spam
folderName
required
string
ms
required
integer format: int64
seedProvider
required
string
seedProviderName
required
string
id
required
string
ip
string
medianMs
integer format: int64
name
required
string
short
required
string
slowest
object
folder
required
string
Allowed values: inbox tab spam
folderName
required
string
ms
required
integer format: int64
seedProvider
required
string
seedProviderName
required
string
status
required
string
warmDay
integer format: int64
warmDays
integer format: int64
startedAt
required
string format: date-time
startedBy
required
string
startedByColor
string
startedById
string
status
required
string
Allowed values: sending waiting finished stopped
through
required
string
Allowed values: route provider compare
waitUntil

Copies missing then are Not arrived

string format: date-time

Example 

{
  "attention": [
    {
      "auth": "password",
      "folders": [
        {
          "role": "inbox"
        }
      ],
      "provider": "gmail",
      "status": "connected"
    }
  ],
  "deleteAfter": "24h",
  "tests": [
    {
      "contentKind": "campaign",
      "counts": {
        "notCheckedSeeds": [
          {
            "reason": "signin_failed"
          }
        ]
      },
      "origin": "placement",
      "providers": [
        {
          "counts": {
            "notCheckedSeeds": [
              {
                "reason": "signin_failed"
              }
            ]
          },
          "fastest": {
            "folder": "inbox"
          },
          "slowest": {
            "folder": "inbox"
          }
        }
      ],
      "status": "sending",
      "through": "route"
    }
  ]
}

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