Analytics

Liberal analytic data is available through the API. Currently, we do not support any POST requests on this resource.

Retrieve Contact Counts

Retrieves the total number of contacts associated with your brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by opt-in-status.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts?group=opt_in_status

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts source or opt_in_status. This will group your results by the criteria specified.

Example Response:

{ "totals": { "total": 24763 }, "groups": [ { "name": "Not Subscribed", "total": 83 }, { "name": "Subscribed", "total": 24674 }, { "name": "Unsubscribed", "total": 6 } ] }

Retrieve Contact Growth Analytics

Retrieves the analytics on the growth of your contact list.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/growth

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by contact source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/growth?group=contact_source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts contact_source. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 7000, "average": 244 }, "groups": [ { "name": "Contacts", "total": 7000, "average": 244, "period": { "2024-11-01": 21500, "2024-11-02": 21575, "2024-11-03": 22600, "2024-11-04": 22712, "2024-11-05": 22802, "2024-11-06": 23021, "2024-11-07": 23125, "2024-11-08": 23512, "2024-11-09": 23588, "2024-11-10": 23712, "2024-11-11": 23765, "2024-11-12": 23952, "2024-11-13": 24012, "2024-11-14": 24152, "2024-11-15": 24265, "2024-11-16": 24356, "2024-11-17": 24456, "2024-11-18": 24852, "2024-11-19": 25002, "2024-11-20": 25245, "2024-11-21": 25348, "2024-11-22": 25951, "2024-11-23": 26258, "2024-11-24": 26325, "2024-11-25": 26852, "2024-11-26": 27235, "2024-11-27": 27456, "2024-11-28": 27852, "2024-11-29": 28125, "2024-11-30": 28820 } } ] }

Retrieve Add/Delete Event Analytics

Retrieves the analytics associated with add/delete events within your brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/create-delete-events

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by contact source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/create-delete-events?group=contact_source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts contact_source and type. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 357, "average": 25.5 }, "groups": [ { "name": "Creation", "total": 54, "average": 7.714285714285714, "period": { "2024-11-17": 0, "2024-11-18": 14, "2024-11-19": 30, "2024-11-20": 6, "2024-11-21": 2, "2024-11-22": 2, "2024-11-23": 0 } }, { "name": "Deletion", "total": 303, "average": 43.285714285714285, "period": { "2024-11-17": 0, "2024-11-18": 13, "2024-11-19": 31, "2024-11-20": 105, "2024-11-21": 52, "2024-11-22": 102, "2024-11-23": 0 } } ] }

Retrieve Opt-In Status Event Analytics

Retrieves the analytics associated with opt-in status events within your brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/opt-in-status-events

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by contact source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/contacts/opt-in-status-events?group=contact_source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts contact_source, contact_unsubscribe_source, and opt_in_status. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 357, "average": 25.5 }, "groups": [ { "name": "Import", "total": 54, "average": 7.714285714285714, "period": { "2024-11-17": 0, "2024-11-18": 14, "2024-11-19": 30, "2024-11-20": 6, "2024-11-21": 2, "2024-11-22": 2, "2024-11-23": 0 } }, { "name": "Inbox", "total": 303, "average": 43.285714285714285, "period": { "2024-11-17": 0, "2024-11-18": 13, "2024-11-19": 31, "2024-11-20": 105, "2024-11-21": 52, "2024-11-22": 102, "2024-11-23": 0 } } ] }

Retrieve Campaign Analytics

Retrieves the analytics on the brand’s campaigns.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/campaigns

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by contact source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/campaigns?group=contact_source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts contact_source. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 7000, "average": 244 }, "groups": [ { "name": "Contacts", "total": 7000, "average": 244, "period": { "2024-11-01": 21500, "2024-11-02": 21575, "2024-11-03": 22600, "2024-11-04": 22712, "2024-11-05": 22802, "2024-11-06": 23021, "2024-11-07": 23125, "2024-11-08": 23512, "2024-11-09": 23588, "2024-11-10": 23712, "2024-11-11": 23765, "2024-11-12": 23952, "2024-11-13": 24012, "2024-11-14": 24152, "2024-11-15": 24265, "2024-11-16": 24356, "2024-11-17": 24456, "2024-11-18": 24852, "2024-11-19": 25002, "2024-11-20": 25245, "2024-11-21": 25348, "2024-11-22": 25951, "2024-11-23": 26258, "2024-11-24": 26325, "2024-11-25": 26852, "2024-11-26": 27235, "2024-11-27": 27456, "2024-11-28": 27852, "2024-11-29": 28125, "2024-11-30": 28820 } } ] }

Retrieve Analytics for Specific Campaign

Retrieves the analytics on a specific campaign.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/campaigns/{{campaign_id}}

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/campaigns/{{campaign_id}}?group=source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts source. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "contacts": 200, "clicks": 0, "click_rate": 0, "unique_clicks": 0, "unique_click_rate": 0, "unsubscribes": 0, "unsubscribe_rate": 0, "orders": 0, "revenue": 0, "average_order_value": 0, "revenue_per_message": 0 }, "campaign": { "campaign_id": 123, "_brand_id": 123456789, "_created_by_user_id": 3333, "name": "Sale", "body": "This weekend only, 20% off everything in store.", "media_url": null, "audience_size": 200, "status": "sent", "status_detail": null, "status_date": "2024-12-18 13:39:01", "completion_percentage": 100, "created": "2024-12-18 13:39:01", "scheduled": null, "started": "2024-12-18 13:39:01", "finished": "2024-12-18 13:39:01", "last_updated": "2024-12-18 13:39:01" }, "audiences": { "141": { "campaign_audience_id": 111, "_campaign_id": 123, "all_contacts": 100, "_contact_list_id": 222, "_segment_id": null, "size": 100, "created": "2024-12-18 13:39:01" } }, "links": [] }

Retrieve Message Analytics

Retrieves the analytics on the number of messages sent by your brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/messages

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/messages?group=source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts source, status, direction, and weekday. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 120, "average": 17.1428 }, "groups": [ { "name": "Messages", "total": 120, "average": 17.1428, "period": { "2024-10-24": 50, "2024-10-25": 0, "2024-10-26": 10, "2024-10-27": 10, "2024-10-28": 15, "2024-10-29": 10, "2024-10-30": 25 } } ] }

Retrieve Message Credit Analytics

Retrieves the analytics on the number of message credits sent by your brand.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/message/credits

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will group by source.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/message/credits?group=source

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
group Accepts source and status. This will group your results by the criteria specified.
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS
frequency Accepts hour, day, month, year. Returns data grouped by specified frequency.

Example Response:

{ "totals": { "total": 100, "average": 14.2857 }, "groups": [ { "name": "Message Credits", "total": 100, "average": 14.2857, "period": { "2024-10-24": 40, "2024-10-25": 0, "2024-10-26": 10, "2024-10-27": 10, "2024-10-28": 15, "2024-10-29": 10, "2024-10-30": 15 } } ] }

Retrieve Inbox User Analytics

Retrieves the analytics on inbox users.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/inbox/users

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will compare day-over-day.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/inbox/users?compare=DoD

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS

Example Response:

{ "data": [ { "user_id": 1, "name": "John SlickText", "avatar_content": "JS", "assignments": 4, "closures": 4, "average_first_response_time": 45.5, "average_resolution_time": 385.24, "average_handle_time": 426.125 } ] }

Retrieve Inbox Tag Analytics

Retrieves the analytics on inbox tags.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/inbox/tags

You can include additional parameters in the request as described in the Query Parameters section. For instance, the request below will compare day-over-day.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/inbox/tags?compare=DoD

The query parameters available for this resource are listed below.

QUERY STRING DESCRIPTION
compare Accepts YoY, QoQ, MoM, WoW, DoD, PoP. This will compare the returned data against the previous period of time.
start Start date/time of information. Format YYYY-MM-DD HH:MM:SS
end End date/time of information. Format YYYY-MM-DD HH:MM:SS

Example Response:

{ "data": [ { "inbox_tag_id": 3, "name": "Nashville", "color": "#23ddcd", "additions": 3, "closures": 4, "average_first_response_time": 45.6, "average_resolution_time": 0, "average_handle_time": 0 } ], "pagingData": { "prevPage": null, "currentPage": null, "nextPage": null, "currentPageString": null, "hasMore": false } }

Retrieve Specific Workflow Analytics

Retrieves the analytics for a workflow with the Workflow ID equal to {{id}}. The Workflow ID can be found using the retrieve all workflows endpoint.

GET https://dev.slicktext.com/v1/brands/{{brand_id}}/analytics/workflows/{{id}}

Example Response:

{ "totals": { "entrances": 11, "current": 0, "exits": 11, "messages": 1, "clicks": 1, "click_rate": 0.09090909090909091, "unique_clicks": 1, "unique_click_rate": 0.09090909090909091, "unsubscribes": 0, "unsubscribe_rate": 0, "orders": 0, "revenue": 0, "average_order_value": 0, "revenue_per_entrance": 0 }, "workflow": { "workflow_id": 2222, "_brand_id": 123456789, "name": "Welcome Series", "description": null, "entry_rule": "oneAtTime", "active": 0, "created": "2024-11-05 19:57:49", "last_updated": "2024-11-20 17:38:18", "last_activated": "2024-11-13 02:56:24", "last_deactivated": "2024-11-20 17:38:18", "last_cleared": null }, "links": [] }