Skip to content
ReputeCastReputeCast Docs

The period's numbers, the route, alerts, incidents and the keys that can send

GET
/api/v1/workspaces/{workspace}/transactional/overview
curl --request GET \
  --url 'https://reputecast.example.com/api/v1/workspaces/acme-newsletter/transactional/overview?period=24h' \
  --header 'Authorization: Bearer <token>'

Permission: transactional:view

The Templates tab’s header and side cards, and the Overview’s Transactional card.

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

Query Parameters

Section titled “Query Parameters”
period
string
default: 7d
Allowed values: 24h 7d 30d
includeTest

Count messages sent with test-mode keys

boolean

Count messages sent with test-mode keys

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
alerts
required
Array<object>
object
bounced
integer format: int64
domains
Array<object>
object
count
required
integer format: int64
domain
required
string
typoOf

The common domain this one looks like a typo of

string
endedAt
string format: date-time
fallback
string
hard
integer format: int64
id
required
string
kind
required
string
Allowed values: bounce_rate failed median_delivery failover
lost
integer format: int64
medianMs
integer format: int64
messages
integer format: int64
provider

The provider messages failed over from

object
id
required
string
name
required
string
seenAt
string format: date-time
sent
integer format: int64
startedAt
required
string format: date-time
template

Id is the template’s ID (password-reset)

object
id
required
string
name
required
string
threshold
required
number format: double
value
required

Bounce rate %, failed messages, median seconds or failed-over messages

number format: double
can
required
object
content
required
boolean
edit
required
boolean
editRoute
required
boolean
manageKeys
required
boolean
publish
required
boolean
send
required
boolean
endpoint
required
string
failover
object
code
string
from
required
object
id
required
string
name
required
string
lost
required
integer format: int64
medianMs
integer format: int64
messages
required
integer format: int64
recovering
required
boolean
since
required
string format: date-time
to
required
object
id
required
string
name
required
string
firstRun
required
object
keys
required
integer format: int64
messages
required
integer format: int64
published
required
integer format: int64
senders
required

Senders on Transactional domains

integer format: int64
templates
required
integer format: int64
verifiedSender
required
boolean
hour
required
object
bounceRate
required
number format: double
bounced
required
integer format: int64
medianMs
integer format: int64
sent
required
integer format: int64
incidents
required
Array<object>
object
bounced
integer format: int64
domains
Array<object>
object
count
required
integer format: int64
domain
required
string
typoOf

The common domain this one looks like a typo of

string
endedAt
string format: date-time
fallback
string
hard
integer format: int64
id
required
string
kind
required
string
Allowed values: bounce_rate failed median_delivery failover
lost
integer format: int64
medianMs
integer format: int64
messages
integer format: int64
provider

The provider messages failed over from

object
id
required
string
name
required
string
seenAt
string format: date-time
sent
integer format: int64
startedAt
required
string format: date-time
template

Id is the template’s ID (password-reset)

object
id
required
string
name
required
string
threshold
required
number format: double
value
required

Bounce rate %, failed messages, median seconds or failed-over messages

number format: double
includeTest
required
boolean
keys
required
Array<object>
object
categories
required

Category names the key is limited to

Array<string>
createdAt
required
string format: date-time
createdBy
required
string
expired
required
boolean
expiresAt
string format: date-time
id
required
string
lastUsedAt
string format: date-time
lastUsedIp
string
masked
required
string
mode
required
string
Allowed values: live test
name
required
string
preset
required
string
Allowed values: send_only smtp ""
ratePerSecond
required
integer format: int64
templates
required
Array<string>
testAddresses
required
Array<string>
period
required
string
Allowed values: 24h 7d 30d
route
required
object
conditions
required
integer format: int64
configured
required
boolean
fallback
object
id
required
string
name
required
string
policy
string
Allowed values: automatic pause_and_ask warm_only ""
primary
object
id
required
string
name
required
string
priority
required
boolean
system
object
id
required
string
name
required
string
stats
required
object
bounceRate
required
number format: double
bounced
required
integer format: int64
clicked
required
integer format: int64
complained
required
integer format: int64
complainedOn
required
Array<string>
complaintRate
required
number format: double
deferred
required
integer format: int64
delivered
required
integer format: int64
deliveryRate
required
number format: double
failed
required
integer format: int64
keys
required
integer format: int64
medianMs
integer format: int64
opened
required
integer format: int64
optedOut
required
integer format: int64
rejected
required
integer format: int64
rejectedReason

10 suppressed · 2 opted out

string
sent
required
integer format: int64
smtp
required
boolean
suppressed
required
integer format: int64

Example 

{
  "alerts": [
    {
      "kind": "bounce_rate"
    }
  ],
  "incidents": [
    {
      "kind": "bounce_rate"
    }
  ],
  "keys": [
    {
      "mode": "live",
      "preset": "send_only"
    }
  ],
  "period": "24h",
  "route": {
    "policy": "automatic"
  }
}

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