Skip to content
ReputeCastReputeCast Docs

One placement test: its copies, the matrix and the guidance

GET
/api/v1/workspaces/{workspace}/placement/tests/{test}
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/placement/tests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --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

test
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
canRun
required
boolean
conditionalShows
string
conditionalVersion
integer format: int64
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
copies
required
Array<object>
object
arriveMs
integer format: int64
deferrals
required
integer format: int64
dkim
string
dmarc
string
error

Why the provider refused the copy

string
first
required
boolean
folder
string
Allowed values: inbox tab spam ""
folderName

The mailbox’s own name: Junk Email, Bulk, Spamverdacht

string
handedAt
string format: date-time
id
required
string
lastEvent
object
at
required
string format: date-time
code
string
diagnostic
string
host
string
type
required

Delivered, deferred, soft_bounce, hard_bounce, complaint, rejected…

string
late
required
boolean
lateUntil
string format: date-time
providerId
string
providerName
required
string
reason
string
Allowed values: signin_failed signin_expired seed_removed stopped unsent ""
reasonAt
string format: date-time
receivedAt
string format: date-time
round
required
integer format: int64
seedEmail
required
string
seedId
string
seedProvider
required
string
seedProviderName
required
string
sendAt
required
string format: date-time
spf
string
status
required
string
Allowed values: queued sent failed found not_arrived not_checked
tab

Primary, Promotions, Focused, Other

string
copiesDeletedAt
string format: date-time
copiesDeletedBy
string
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
deleteAfter
required
string
Allowed values: 24h finished never
deleteAt
string format: date-time
fallbackGreeting
string
finishReason
string
Allowed values: all_found timeout stopped ""
finishedAt
string format: date-time
fromEmail
required
string
fromName
required
string
gapMinutes
required
integer format: int64
guidance
required
Array<object>
object
at
required
Array<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
authProviders
required
integer format: int64
cause
required
string
Allowed values: readiness auth warmup reputation
copies
required
integer format: int64
earlier
object
contentName
required
string
copies
required
integer format: int64
inbox
required
integer format: int64
startedAt
required
string format: date-time
testId
required
string
hostRepute
required
boolean
ip
string
other
object
copies
required
integer format: int64
inbox
required
integer format: int64
name
required
string
providerId
required
string
spam
required
integer format: int64
providerId
required
string
providerName
required
string
readiness
object
blocking
required

The blocking checks, in the reader’s language

Array<string>
blocks
required
integer format: int64
evidence
required

One sentence per blocking check

Array<string>
passed
required
integer format: int64
warnings
required
integer format: int64
spam
required
integer format: int64
status
required
string
warmDay
integer format: int64
warmDays
integer format: int64
hostRepute
required
boolean
id
required
string
language
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
rounds
required
integer format: int64
runHelpers
required
Array<string>
seeds
required
Array<object>
object
email
required
string
id
string
position
required
integer format: int64
provider
required
string
providerName
required
string
status
required

The seed’s status now (removed when it’s gone)

string
statusAt
string format: date-time
startedAt
required
string format: date-time
startedBy
required
string
startedByColor
string
startedById
string
status
required
string
Allowed values: sending waiting finished stopped
stoppedAt
string format: date-time
stoppedBy
string
stream
required
string
subject
required
string
through
required
string
Allowed values: route provider compare
variant
string
waitUntil

Copies missing then are Not arrived

string format: date-time

Example 

{
  "contentKind": "campaign",
  "copies": [
    {
      "folder": "inbox",
      "reason": "signin_failed",
      "status": "queued"
    }
  ],
  "counts": {
    "notCheckedSeeds": [
      {
        "reason": "signin_failed"
      }
    ]
  },
  "deleteAfter": "24h",
  "finishReason": "all_found",
  "guidance": [
    {
      "cause": "readiness"
    }
  ],
  "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