Analytics


The analytics resource provides you all of the same insights into your textword, campaign and coupon performance as you would get through the SlickText analytics dashboard. The following actions can be performed on this resource...

Retrieve Textword Analytics

Retrieves analytics data for the textword ID equal to {id}.

All data is relative to the data range provided when the request is made. If no date range is provided, the lifetime of that specific textword will be used by default.

GET https://api.slicktext.com/v1/analytics/textwords/{id}

Example response:


        {
        
            "links": {
                "self": "https://api.slicktext.com/v1/analytics/textwords/4565335"
            },
            "textword": {
                "id": "4565335",
                "word": "burger",
                "added": "2012-07-01 03:16:07",
                "autoReply": "Thanks for joining Burger Bar's VIP text list. Check out our website @ https://slkt.io/4b for great deals!",
                "optOuts": "128",
                "ageRequirement": "0",
                "doubleOptIn": "1",
                "termsLink": "https://slicktext.com/tc.php",
                "brandName": "Burger Bar",
                "brandEmail": "info@burgerbar.com",
                "brandSpamEmail": "spam@burgerbar.com",
                "brandWebsite": "burgerbar.com"
            },
            "analytics": {
                "dates": {
                    "startDate": "2012-07-01 03:16:07",
                    "endDate": "2017-11-14 14:48:29"
                },
                "optIns": {
                    "totalOptIns": 32764,
                    "activeSubscribers": 32600
                },
                "optOuts": {
                    "optOuts": 164
                },
                "badNumbers": {
                    "badNumbersCleaned": 265
                },
                "messageTypes": {
                    "Standard Campaigns": 48,
                    "Birthday Campaigns": 485,
                    "Drip Campaigns": 364
                },
                "usage": {
                    "textsUsed": 1564800
                },
                "subscriberStates": {
                    "PA": 32500,
                    "NY": 100
                },
                "subscriberCities": {
                    "Pittsburgh": "32500",
                    "Jamestown": "100"
                },
                "autoReplyLinks": [
                    {
                        "longUrl": "https://slicktext.com",
                        "shortUrl": "https://slkt.io/4b",
                        "clicks": 26453
                    }
                ],
                "subscriberEmailsCaptured": {
                    "emailsCaptured": 19646
                },
                "subscriberBirthdaysCaptured": {
                    "birthdaysCaptured": 27875
                },
                "optInMethods": {
                    "mobile": 32600
                }
            }
        
        }
        

Arguments

Parameter Description
startDate The timestamp for the start of the date range you are looking to retrieve data for. The expected format is YYYY-MM-DD HH:MM:SS and URL encoded.
endDate The timestamp for the end of the date range you are looking to retrieve data for. The expected format is YYYY-MM-DD HH:MM:SS and URL encoded.

Retrieve Campaign Analytics

Retrieves analytics data for the campaign / message equal to {id}.

GET https://api.slicktext.com/v1/analytics/messages/{id}

Example response:


        {
        
            "links": {
                "self": "https://api.slicktext.com/v1/analytics/messages/3910282"
            },
            "message": {
                "id": "4565345335",
                "campaign": "Application Reminder",
                "body": "To all team members, don't forget the deadline for applications is tomorrow! You can find the form here: https://slkt.io/4b",
                "mediaUrl": null,
                "textword": "54275490",
                "contact": null,
                "segment": null,
                "count": "602",
                "sent": "2017-09-20 10:20:18",
                "autoReply": "0",
                "scheduled": null
            },
            "analytics": {
                "subscriberActivity": {
                    "optOuts": {
                        "10:00 am": 4,
                        "11:00 am": 0,
                        "12:00 pm": 0,
                        "1:00 pm": 0,
                        "2:00 pm": 0,
                        "3:00 pm": 0,
                        "4:00 pm": 0,
                        "5:00 pm": 0,
                        "6:00 pm": 0,
                        "7:00 pm": 0,
                        "8:00 pm": 0,
                        "9:00 pm": 0,
                        "10:00 pm": 0,
                        "11:00 pm": 0,
                        "12:00 am": 0,
                        "1:00 am": 0,
                        "2:00 am": 0,
                        "3:00 am": 0,
                        "4:00 am": 0,
                        "5:00 am": 0,
                        "6:00 am": 0,
                        "7:00 am": 0,
                        "8:00 am": 0
                    },
                    "optIns": {
                        "10:00 am": 7,
                        "11:00 am": 0,
                        "12:00 pm": 2,
                        "1:00 pm": 6,
                        "2:00 pm": 0,
                        "3:00 pm": 0,
                        "4:00 pm": 1,
                        "5:00 pm": 0,
                        "6:00 pm": 0,
                        "7:00 pm": 0,
                        "8:00 pm": 0,
                        "9:00 pm": 0,
                        "10:00 pm": 0,
                        "11:00 pm": 0,
                        "12:00 am": 0,
                        "1:00 am": 0,
                        "2:00 am": 0,
                        "3:00 am": 0,
                        "4:00 am": 0,
                        "5:00 am": 0,
                        "6:00 am": 0,
                        "7:00 am": 0,
                        "8:00 am": 0
                    }
                },
                "messageLinks": [
                    {
                        "longUrl": "https://slicktext.com",
                        "shortUrl": "https://slkt.io/4b",
                        "clicks": 26453
                    }
                ]
            }
        
        }
        

Retrieve Coupon Analytics

Retrieves analytics data for the coupon ID equal to {id}.

All data is relative to the data range provided when the request is made. If no date range is provided, the lifetime of that specific coupon will be used by default.

GET https://api.slicktext.com/v1/analytics/coupons/{id}

Example response:


        {
            "links": {
                "self": "http://api.slicktext.com/v1/analytics/coupons/114558/"
            },
            "coupon": {
                "id": 114558,
                "couponHash": "92dha631d5e8f8a8d2e4R1856f9f3f9a",
                "couponName": "Tom's Grill - Weekday Special",
                "couponDescription": "Used only on the weekdays",
                "couponLink": "https://slkt.io/xGz",
                "created": "2017-10-28 19:22:11"
            },
            "analytics": {
                "views": 598,
                "uniqueViews": 467,
                "redemptions": 295,
                "upVotes": 157,
                "downVotes": 14,
                "callClicks": 63,
                "websiteClicks": 98,
                "facebookClicks": 22,
                "instagramClicks": 39,
                "directionsClicks": 22
            }
        
        }
        

Arguments

Parameter Description
startDate The timestamp for the start of the date range you are looking to retrieve data for. The expected format is YYYY-MM-DD HH:MM:SS and URL encoded.
endDate The timestamp for the end of the date range you are looking to retrieve data for. The expected format is YYYY-MM-DD HH:MM:SS and URL encoded.

You're in excellent hands. We work with some of the world's greatest companies.