Get summary report

Description

Retrieves a summary report.

Request URL

Method: POST

https://example.com/api/v1.1/reports/summary

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format. By default – json
resource_id	int	1	No	resource ID
date_from	string	"2018-08-10"	Yes	Time period start date
date_to	string	"2018-08-15"	Yes	Time period end date
data_type	string	"segment"	Yes	Audience source type
data_id	*	1	No	Audience source ID
data_group	string	"campaign"	No	Data grouping parameter ("day" , "week" or "month")
show_deleted	bool	false	No	Show deleted entries data
is_test_data	bool	false	No	Show test and watchers data

Report sources:

data_type	Description	data_id parameter available	data type of data_id parameter
campaign	Campaign	Yes	int
list	Database	Yes	int
segment	Segment	Yes	int
message	Message template	Yes	int
sender	Sender	Yes	int
domaingroup	Email domain group	Yes	string
domain	Email domain	No	-
vendor	Vendor	No	-
day	Daily report	No	-
week	Weekly report	No	-
month	Monthly report	No	-
environment	Mobile or desktop traffic	No	-

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "data_group": "vendor",
    "data_id": 7,
    "data_type": "list",
    "date_from": "2024-04-04",
    "date_to": "2024-05-05",
    "format": "json"
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <data_group>vendor</data_group>
  <data_id>7</data_id>
  <data_type>list</data_type>
  <date_from>2024-04-04</date_from>
  <date_to>2024-05-05</date_to>
  <format>xml</format>
</xml>

Response example

JSON

{
    "data": [
        {
            "clicks": 22,
            "complains": 2,
            "confirms": 7,
            "delivs": 22,
            "hbounces": 3,
            "id": "Vendor #2",
            "opens": 44,
            "reads": 2,
            "sbounces": 15,
            "sends": 41,
            "suppresses": 1,
            "uclicks": 15,
            "unsubs": 3,
            "uopens": 22
        },
        {
            "clicks": 34,
            "complains": 4,
            "confirms": 13,
            "delivs": 24,
            "hbounces": 7,
            "id": "Vendor #1",
            "opens": 48,
            "reads": 3,
            "sbounces": 21,
            "sends": 31,
            "suppresses": 3,
            "uclicks": 21,
            "unsubs": 6,
            "uopens": 24
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <clicks>22</clicks>
    <complains>2</complains>
    <confirms>7</confirms>
    <confirmsubs>0</confirmsubs>
    <delivs>22</delivs>
    <hbounces>3</hbounces>
    <id>Vendor #2</id>
    <opens>44</opens>
    <reads>2</reads>
    <sbounces>15</sbounces>
    <sends>41</sends>
    <suppresses>1</suppresses>
    <uclicks>15</uclicks>
    <unsubs>3</unsubs>
    <uopens>22</uopens>
  </data>
  <data>
    <clicks>34</clicks>
    <complains>4</complains>
    <confirms>13</confirms>
    <confirmsubs>0</confirmsubs>
    <delivs>24</delivs>
    <hbounces>7</hbounces>
    <id>Vendor #1</id>
    <opens>48</opens>
    <reads>3</reads>
    <sbounces>21</sbounces>
    <sends>31</sends>
    <suppresses>3</suppresses>
    <uclicks>21</uclicks>
    <unsubs>6</unsubs>
    <uopens>24</uopens>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text
id	string	Report data source ID
clicks	int	Email clicks
complains	int	FBL complaints
opens	int	Opened emails
reads	int	Emails read
replies	int	Email replies
sends	int	Email sends
confirms	int	Confirmed emails
delivs	int	Email deliveries
undelivs	int	Undelivered emails
unsubs	int	Opt-outs
uopens	int	Email unique opens
ureads	int	Email unique reads
offence	int	Communication policy offences
glanceds	int	Messages glanced
hbounces	int	Email hard bounces
sbounces	int	Email soft bounces
suppresses	int	Suppressed messages
uclicks	int	Email unique clicks
ulclicks	int	Unique email opt-out clicks
sends_push	int	Push sends
clicks_push	int	Push clicks
uclicks_push	int	Push unique clicks
delivs_push	int	Push deliveries
ureads_push	int	Push unique reads
opens_push	int	Push opens
uopens_push	int	Push unique opens
push_ctr	int	Push CTR
sbounce_push	int	Soft bounce push
hbounce_push	int	Hard bounce push
sends_sms	int	SMS sends
clicks_sms	int	SMS clicks
uclicks_sms	int	SMS unique clicks
delivs_sms	int	SMS deliveries
undelivs_sms	int	Undelivered SMS
sms_ctr	int	SMS CTR
unsubs_sms	int	SMS opt-out rate
open_rate	int	Opens rate
push_deliv_rate	int	Push deliveries rate
u_read_rate	int	Unique read rate
u_open_click_rate	int	Unique opens and clicks rate
sb_rate	int	Soft bounce rate
email_read_rate	int	Emails read rate
delivery_rate	int	Deliveries rate
email_unsub_rate	int	Email opt-out rate
email_u_read_rate	int	Email unique rate
open_click_rate	int	CTOR
suppresses_rate	int	Suppressed messages rate
unsub_rate	int	Opt-out rate
u_click_rate	int	Unique clicks rate
click_rate	int	Clicks rate
sms_deliv_rate	int	SMS deliveries rate
hb_rate	int	Hard bounce rate
push_open_rate	int	Push open rate
undelivs_push	int	Undelivered push messages
complain_rate	int	FBL complains rate
u_open_rate	int	Unique opens rate
email_reply_rate	int	Reply rate im emails
sends_total	int	Total sends
delivs_total	int	Total delivered
undelivs_total	int	Total undelivered
reads_total	int	Total reads
clicks_total	int	Total clicks
uclicks_total	int	Total unique clicks
opens_total	int	Total unique opens
ureads_total	int	Total unique reads
uopens_total	int	Total unique opens