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 | Report source |
show_deleted | bool | false | No | Show deleted entries data |
is_test_data | bool | false | No | Show test and watchers data |
Report sources:
"data_group"
and "data_type"
parameters have a common set of values.
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
{
"data_group": "vendor",
"data_id": 7,
"data_type": "list",
"date_from": "2017-04-04",
"date_to": "2017-05-05",
"format": "json",
"token": "abcdefghijklmnqrstuvwxyz"
}
Response example
{
"data": [
{
"clicks": 22,
"complains": 2,
"confirms": 7,
"confirmsubs": 0,
"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,
"confirmsubs": 0,
"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"
}
Response parameters
Parameter | Type | Description |
---|---|---|
error | int | Error code |
error_text | string | Error text |
id | string | Report data source ID |
clicks_sms | int | SMS clicks |
delivs_sms | int | SMS deliveries |
sends_sms | int | SMS sends |
uclicks_sms | int | SMS with no clicks |
undelivs_sms | int | Undelivered SMS |
sends | int | Email sends |
delivs | int | Email deliveries |
hbounces | int | Hard bounces |
sbounces | int | Soft bounces |
suppresses | int | Suppressedmessages |
undelivs | int | Undelivered messages |
opens | int | Opened emails |
uopens | int | Unique email opens |
clicks | int | Email clicks |
uclicks | int | Email unique clicks |
replies | int | Email replies |
ulclicks | int | Unique email specific link clicks |
ulconfirmsubs | int | Unique email opt-in clicks |
ulunsubs | int | Unique email opt-out clicks |
confirms | int | Opt-ins |
confirmsubs | int | Confirmed subscriptions |
complains | int | FBL complaints |
unsubs | int | Unsubscribers |
reads | int | Emails read |
skimmeds | int | Messages skimmed |
glanceds | int | Messages glanced |
web_imports | int | Web profile imports |
api_imports | int | API profile imports |
api_unsubs | int | API unsubscribes |
manual_imports | int | Manual profile imports |
manual_unsubs | int | Manual unsubscribes |
file_imports | int | from file profile imports |
clicks_push | int | Push clicks |
delivs_push | int | Push deliveries |
offence | int | Communication policy offences |
opens_push | int | Push opens |
pixel_opens | int | Pixel script activations |
push_imports | int | Push profile imports |
push_merges | int | |
push_subscribes | int | Push opt-ins |
save_web_version | int | Web versions saved |
sends_push | int | Push sent count |
submanagers | int | |
subscribers | int | |
uclicks_push | int | Push unique clicks |
ulclicks_push | int | Push unique link clicks |
ulclicks_sms | int | SMS unique link clicks |
uopens_push | int | Push unique opens |