One copy: where it landed, its headers and the provider's events

GET

/api/v1/workspaces/{workspace}/placement/tests/{test}/copies/{copy}

package main

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

func main() {

  url := "https://reputecast.example.com/api/v1/workspaces/acme-newsletter/placement/tests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"

  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/placement/tests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
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/placement/tests/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/copies/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Permission: deliverability:view

Authorizations

bearer

Parameters

Path Parameters

workspace

required

Workspace slug

string

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

Workspace slug

test

required

string format: uuid

copy

required

string format: uuid

Responses

200

application/json

object

copy

required

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

required

string

lastEvent

object

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

dkim

object

aligned

boolean

detail

string

domain

string

result

required

string

selector

string

dmarc

object

aligned

boolean

detail

string

domain

string

result

required

string

selector

string

events

required

Array<object>

object

required

string format: date-time

code

string

diagnostic

string

host

string

type

required

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

string

headers

required

string

keyHeaders

required

string

path

string

providerMessageId

string

readVia

required

string

Allowed values: imap graph gmail

spf

object

aligned

boolean

detail

string

domain

string

result

required

string

selector

string

testStatus

required

string

waitUntil

string format: date-time

Example

{
  "copy": {
    "folder": "inbox",
    "reason": "signin_failed",
    "status": "queued"
  },
  "readVia": "imap"
}

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