Introduction
The Splio Report API provides the statistics of email, SMS and Forward campaigns for Splio customers.
Access
Base URL
Like other SPLIO APIs, the base URL depends on the hosting location of the universe.
If you’re unsure about the hosting location of your universe, please ask your Customer Success Manager.
Europe hosting
- https://s3s.fr/api/reports/nph-1.pl
China hosting
- https://api.spl4cn.com/api/reports/nph-1.pl
In the next pages of this document, the examples are using either of the base URLs. However, you need to stick to the one relevant to your own case.
HTTPS is both required and enforced. Any request to the http (non-secured) address will be rejected without any automatic redirection to the secured URL.
Authentication
All requests need to be authenticated through credentials generated and communicated to the customer upon request.
- universe id (e.g.: my_universe_id)
- password (e.g.: my_api_key)
Request parameters
|
Parameter |
Mandatory |
Description |
|
|
universe |
Yes |
Name of your universe |
|
|
key |
Yes |
Your API key |
|
|
channel |
Yes |
“email” / “sms” / “forward” |
|
|
id |
|
To retrieve only one specific sendout |
|
|
before |
|
Date: YYYY-MM-DD [HH:MM:SS] , or numerical id |
|
|
after |
|
Date: YYYY-MM-DD [HH:MM:SS] , or numerical id |
|
Both GET and POST methods are supported, but POST is more secure and therefore recommended.
Query examples:
GET https://s3s.fr/api/reports/nph-1.pl?universe={ universe }&key={ api_key }&channel={ email }&id={ sendout_id }&before={ 2018-06-01 }&after={ 2018-06-25 }
POST https://s3s.fr/api/reports/nph-1.pl?
Query data
Response format
Data returned in response messages is always UTF-8 encoded and JSON formatted.
The unique response language is English.
Up to 100 sendouts are returned in the response
Error Codes & Responses
Responses are returned as JSON objects that contain "code", "name" and "description" attributes. "code" and "name" are the HTTP code and name response:
- Code: 200 for a correct response “message”: ”ok”
- Code: 400 for an incorrect response “message”: “invalid key for this universe”
Response examples
Correct response for email
{
"status" : "ok", "result" : {
"sendouts" : {
"2289940" : {
"throttling" : "0",
"status" : "done", "message" : {
"thumbnail" : "http://thumb.splio.com/6ik/dI/5P3G-m.png", "language" : "fr",
"sender_replyto" : "fullservice@splio.fr", "subject" : "test_aid",
"name" : "test_aid",
"sender_email" : "fullservice@splio.fr", "url" : "http://file.splio3.fr/6ik/dI/5P3G/", "id" : "6ikdI5P3G",
"sender_name" : "Splio"
},
"reactions" : { "opens" : "5",
"clicks" : "11",
"turnover" : "0.00",
"buyers" : "0",
"spam complaints" : "0", "unsubscribes" : "0"
},
"campaign" : "6ikdJa68o", "starttime" : "2016-07-04 13:55:32",
"id" : "6ikdLAFji",
"endtime" : "2016-07-04 13:55:32",
"links" : {
"33" : {
"clicks" : "11",
"turnover" : "0.00",
"name" : "Exemple1",
"url" : "https://wwww.exemple1.com", "category" : "Exemple1"
},
"32" : {
"clicks" : "0",
"turnover" : "0.00",
"name" : "Exemple2",
"url" : "https://wwww.exemple2.com", "category" : "Exemple2"
},
}
},
"recipients" : {
"soft bounces" : "0",
"delivered" : "13",
"clickers" : "1",
"sent" : "13",
"openers" : "5",
"hard bounces" : "0",
"total" : "13"
}
}
}
},
"message" : "ok", "code" : 200 }
}
Incorrect response
{
"status" : "error",
"message" : "invalid key for this universe", "code" : 400
}
Response examples
Message
|
sendouts |
Sendouts’ ID (Actions’ ID on the platform) |
|
thumbnail |
Thumbnail of the send emails or sms |
|
language |
Language of the message configured on the Splio customer platform |
|
sender_replyto |
Reply-to email address of the message |
|
subject |
Subject of the message |
|
name |
Name of the message configured on the platform |
|
sender_email |
Sender’s email of the message |
|
url |
Public URL of the message |
|
id |
Message’s ID |
|
sender_name |
Sender name of the message |
Campaign
|
campaign |
Splio’s campaign ID. A campaign can include several sendtous |
|
starttime |
Start time of the first send email of the campaign |
|
id |
Sendouts’ ID (Actions’ ID on the platform) |
|
endtime |
Time of the last email send of the campaign |
Links
|
clicks |
Total number of clicks for the link |
|
turnover |
Turnover generated by the link. Calculated with Splio’s sales tracker |
|
name |
Value set for the “name” parameter of the link |
|
url |
URL of the link given in the HTML |
|
category |
Value set for the « category » parameter of the link |
Recipients
|
Soft bounce |
Total number of soft bounces for the sendout / action |
|
Delivered |
Total number delivered to the recipients |
|
clickers |
Total number of recipients having clicked on a link in the sendout |
|
Sent |
Total number of email sent |
|
Openers |
Total number of recipients having opened the sendout |
|
Hard bounce |
Total number of hard bounces for the sendout / action |
|
Total |
Total number of recipients |