Methods

Objects

analytics/sms

SMS Analytics

Method Description
analytics/sms.history SMS count, parts, debit and credit over time.
analytics/sms.history_out Distribution of SMS by fields over time
analytics/sms.history_out_by_status Distribution of outbound SMS by fields over time by status
analytics/sms.summary Summary of your SMS count, parts, debit and credit.
analytics/sms.summary_out Distribution of SMS by fields
analytics/sms.summary_out_by_status Summary of your outbound SMS count, parts, debit and credit by status

Methods

analytics/sms.history

Description

SMS count, parts, debit and credit over time.

Signature

method: analytics/sms.history

params: [string from, string to]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO

Result

Type Description Format/Object
object Analytics Object: Analytics.SMS.History

analytics/sms.history_out

Description

Distribution of SMS by fields over time

Signature

method: analytics/sms.history_out

params: [string from, string to, array fields]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
fields array Array of fields you want to get analytics by
Values: "BILLING_LABEL", "COUNTRY_CODE", "COUNTRY_REGION", "STATUS"
NO

Result

Type Description Format/Object
array Array of objects. Each object has the properties "date" and "distribution". The "distribution" property is a key/value dictionary of selected fields and Analytics.SMS.History.OUT objects. Array of Analytics.SMS.History.OUT objects.

analytics/sms.history_out_by_status

Description

Distribution of outbound SMS by fields over time by status

Signature

method: analytics/sms.history_out_by_status

params: [string from, string to]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO

Result

Type Description Format/Object
array Array of objects. Each object has the properties "date" and "distribution". The "distribution" property is a key/value dictionary of statuses and Analytics.SMS.History.OUT objects. Array of Analytics.SMS.History.OUT objects.

analytics/sms.summary

Description

Summary of your SMS count, parts, debit and credit.

Signature

method: analytics/sms.summary

params: [string from, string to]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO

Result

Type Description Format/Object
object Analytics Object: Analytics.SMS.Summary

analytics/sms.summary_out

Description

Distribution of SMS by fields

Signature

method: analytics/sms.summary_out

params: [string from, string to, array fields]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
fields array Array of fields you want to get analytics by
Values: "BILLING_LABEL", "COUNTRY_CODE", "COUNTRY_REGION", "STATUS"
NO

Result

Type Description Format/Object
object Dictionary of key/value. Keys are the selected fields. If you select more than one field, the result is a multi-dimensional array. Values are SMS count, parts, debit, credit. Object: Analytics.SMS.Summary.OUT

analytics/sms.summary_out_by_status

Description

Summary of your outbound SMS count, parts, debit and credit by status

Signature

method: analytics/sms.summary_out_by_status

params: [string from, string to]

Parameters

Parameter Type Description NULL
from string Date from
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO
to string Date to
Format: datetime (YYYY-MM-DD HH:MM:SS in UTC timezone. Example: "2012-04-24 23:42:00")
NO

Result

Type Description Format/Object
object Dictionary of key/value. Keys are the SMS statuses. Values are SMS count, parts, debit, credit. Object: Analytics.SMS.Summary.OUT