Report API v1.0 Splio Customer Platform

Transcription

1 Report API v1.0 Splio Customer Platform SPLIO Customer Platform - REPORT API EN v1.docx

2 Table of Contents Introduction... 3 Access... 3 Base URL... 3 Europe hosting... 3 China hosting... 3 Authentication... 3 Request parameters... 4 Response format... 4 Error Codes & Responses... 4 Response examples... 5 Correct response for Incorrect response... 6 Response examples

3 Introduction The Splio Report API proves the statistics of , 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 China hosting 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 (e.g.: my_universe_) password (e.g.: my_api_key) 3

4 Request parameters Parameter Mandatory Description universe Yes Name of your universe key Yes Your API key channel Yes / sms / forward To retrieve only one specific sendout before Date: YYYY-MM-DD [HH:MM:SS], or numerical after Date: YYYY-MM-DD [HH:MM:SS], or numerical Both GET and POST methods are supported, but POST is more secure and therefore recommended. Query examples: GET universe &key={ api_key &channel={ &={ sendout_ &before={ &after={ POST Query data universe={ universe &key={ your_api_key &channel={ &={ sendout_ &before={ &after={ 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 : inval key for this universe 4

5 Response examples Correct response for { "status" : "ok", "result" : { "sendouts" : { " " : { "throttling" : "0", "status" : "done", "message" : { "thumbnail" : " "language" : "fr", "sender_replyto" : "fullservice@splio.fr", "subject" : "test_a", "name" : "test_a", "sender_ " : "fullservice@splio.fr", "url" : " "" : "6ikdI5P3G", "sender_name" : "Splio", "reactions" : { "opens" : "5", "clicks" : "11", "turnover" : "0.00", "buyers" : "0", "spam complaints" : "0", "unsubscribes" : "0", "campaign" : "6ikdJa68o", "starttime" : " :55:32", "" : "6ikdLAFji", "endtime" : " :55:32", "links" : { "33" : { "clicks" : "11", "turnover" : "0.00", "name" : "Exemple1", "url" : " "category" : "Exemple1", "32" : { "clicks" : "0", "turnover" : "0.00", "name" : "Exemple2", "url" : " "category" : "Exemple2",, 5

6 "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" : "inval key for this universe", "code" : 400 6

7 Response examples Message sendouts Sendouts ID (Actions ID on the platform) thumbnail Thumbnail of the send s or sms language Language of the message configured on the Splio customer platform sender_replyto Reply-to address of the message subject Subject of the message name Name of the message configured on the patform sender_ Sender s of the message url Public URL of the message Message s ID sender_name Sender name of the message Reactions opens Total number of openings clicks Total number of clicks turnover Turnover generated by the sendouts. Calculated with Splio s sales tracker buyers Total number of buyers. Calculated with Splio s sales tracker spam complaints Spam complaints for the sendouts (if the authors are known) Unsubscribes Total number of unsubscribers Campaign campaign Splio s campaign ID. A campaign can include several sendtous starttime Start time of the first send of the campaign Sendouts ID (Actions ID on the platform) endtime Time of the last 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 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 7

8 SPLIO is a SaaS marketing software company specialized in Retail. Our SaaS Customer Experience Platform ties together all essential components to implement a digital customer hub orchestrating processes of real-time omnichannel strategies. Building on 15 years of vision, partnerships and understanding of the needs of 500+ global and local retailers, SPLIO has developed a unique intuitive platform that allows marketers to unleash their strategy and aligns all departments of a company ensuring a consistent customer centric approach. SPLIO has offices in Paris, Barcelona, Milan, Beijing, Shanghai, Warsaw and São Paulo SPLIO Customer Platform - REPORT API EN v1.docx