Skip to content
ReputeCastReputeCast Docs

The SMS report: delivery, failures by reason with the provider's codes, clicks, replies, cost, progress

GET
/api/v1/workspaces/{workspace}/sms-campaigns/{campaignId}/report
curl --request GET \
  --url https://reputecast.example.com/api/v1/workspaces/acme-newsletter/sms-campaigns/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/report \
  --header 'Authorization: Bearer <token>'

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

campaignId
required

Campaign id

string format: uuid

Campaign id

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
campaignId
required
string
canPause
required
boolean
canResume
required
boolean
completedAt
string format: date-time
countries
required
Array<object>
object
clickPct
required
number format: double
clicks
required
integer format: int64
cost
required
number format: double
country
required
string
delivered
required
integer format: int64
deliveredPct
required
number format: double
failed
required
integer format: int64
optOuts
required
integer format: int64
sender
required
string
sent
required
integer format: int64
skipReason
string
skipped
required
integer format: int64
failures
required
Array<object>
object
codes
required
Array<object>
object
code
required
string
count
required
integer format: int64
provider
required
string
count
required
integer format: int64
limit
required
number format: double
rate
required
number format: double
reason
required
string
held
required
object
lists
required
Array<string>
noConsent
required
integer format: int64
notSent
required
object
key
additional properties
integer format: int64
quietHours
required
integer format: int64
skipReason
string
skipSender
string
skipped
required
integer format: int64
skippedCountries
required
Array<string>
suppressed
required
integer format: int64
helpers
required
Array<string>
links
required
Array<object>
object
domain
required
string
machine
required
integer format: int64
people
required
integer format: int64
url
required
string
localTime
string
name
required
string
outage
object
answer
string
countries
required
Array<string>
failures
required
integer format: int64
hasFallback
required
boolean
held
required
integer format: int64
lastAccepted
string format: date-time
nextTry
string format: date-time
provider
required
string
providerId
required
string
since
string format: date-time
status
required
string
told
required
Array<string>
pause
object
at
string format: date-time
base
required
integer format: int64
by
string
code
string
codeCount
required
integer format: int64
events
required
integer format: int64
held
required
integer format: int64
kind
required
string
Allowed values: auto person outage budget
limit
required
number format: double
metric
string
Allowed values: failed filtered opt_outs ""
provider
string
value
required
number format: double
phase
required
string
Allowed values: scheduled sending paused completed cancelled ""
points
required
Array<object>
object
at
required
string format: date-time
delivered
required
integer format: int64
receiptsWithin
required
number format: double
recipients
required
integer format: int64
replies
required
Array<object>
object
anyCase
required
boolean
at
required
string format: date-time
body
required
string
contact
required
string
contactId
string
id
required
string
keyword
string
kind
required
string
Allowed values: opt_out opt_in help yes reply
lists
required
Array<string>
number
required
string
replied
required
boolean
replyChars
required
integer format: int64
replySegments
required
integer format: int64
zone
required
string
replyCounts
required
object
key
additional properties
integer format: int64
sample
object
contactId
required
string
events
required
Array<object>
object
at
required
string format: date-time
body
string
kind
required
string
link
string
provider
string
seconds
number format: double
sender
string
target
string
name
required
string
scheduleMode
required
string
Allowed values: now at local
scheduledAt
string format: date-time
senders
required
Array<object>
object
adapter
required
string
cost
required
number format: double
countries
required
Array<string>
delivered
required
integer format: int64
deliveredPct
required
number format: double
failed
required
integer format: int64
provider
required
string
sender
required
string
senderKind
required
string
sent
required
integer format: int64
throughput
required
number format: double
zoneSeconds
required
number format: double
shortDomain
required
string
startedAt
string format: date-time
status
required
string
steps
required
Array<object>
object
abbr
required
string
at
required
string format: date-time
countries
required
Array<string>
delivered
required
integer format: int64
local
required
string
region
string
sent
required
integer format: int64
status
required
string
Allowed values: sent sending waiting paused held
total
required
integer format: int64
zone
required
string
tiles
required
object
byProvider
required
Array<object>
object
count
required
integer format: int64
name
required
string
clickPct
required
number format: double
clicks
required
integer format: int64
cost
required
number format: double
delivered
required
integer format: int64
deliveredPct
required
number format: double
failed
required
integer format: int64
failedBy
required
object
key
additional properties
integer format: int64
held
required
integer format: int64
machine
required
integer format: int64
optOutPct
required
number format: double
optOuts
required
integer format: int64
optOutsByKeyword
required
boolean
perText
required
number format: double
planned
required
number format: double
queued
required
integer format: int64
sent
required
integer format: int64
skipped
required
integer format: int64
waiting
required
integer format: int64
withinBudget
required
boolean
timezone
required
string
window
required
string

Example 

{
  "pause": {
    "kind": "auto",
    "metric": "failed"
  },
  "phase": "scheduled",
  "replies": [
    {
      "kind": "opt_out"
    }
  ],
  "scheduleMode": "now",
  "steps": [
    {
      "status": "sent"
    }
  ]
}

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