4.18j

TextMarks API V2 - AutoDoc: TextMarkManager / analytics()

Method: analytics() (GET) - Query and return formatted analytics report

Package: TextMarkManager - Manage a TextMark owned by authenticated user (... View package)

Args:

Req? Name Type Description Test
REQ auth_user User User account / phone# used for login
REQ auth_pass Password Password
REQ tm TextMark TextMark keyword/TRI owned by auth_user
REQ stats CSL Stats desired
REQ date_begin YYYY-MM-DD Date (UTC) First date desired (inclusive)
REQ date_end YYYY-MM-DD Date (UTC) Last date desired (inclusive)
OPT api_key API Key API Key (Register here)

Test:


Docs:

  • This API method queries analytics data, analyzes the data, and returns it in a format suitable for consumption by lightweight clients.
  • Available stats are:
    subs_24hr
    New subscriptions in a 24hr UTC day
    unsubs_24hr
    Unsubscriptions in a 24hr UTC day
    subs_total
    Total subscribers
    mo_sms_uniq_24hr
    Number of unique phone#s texting your TextMark in a 24hr UTC day
    mo_sms_24hr
    Total number of texts to your TextMark in a 24hr UTC day
    mt_sms_24hr
    Total number of texts send from your TextMark in a 24hr UTC day
    sms_24hr
    Total number of texts to and from your TextMark in a 24hr UTC day
    alerts_24hr
    Number of alerts sent on your TextMark in a 24hr UTC day
  • See statistics() for more basic overview data.

Resp:

JSON response.head.rescode==0 for success, or error code otherwise.
JSON-P callback: (as 'jsonp' param, optional) (blank for none)

HTTP:

GET http://help.api2.textmarks.com//TextMarkManager/analytics/

More:

This page documents a single API function analytics() within the TextMarkManager package of the TextMarks Text Message API.
You may use the interactive form above to invoke this function and observe its actual JSON response.

More resources: