Allows user to retrieve the statistical report ID number of newsletters by searching based on the newsletter(s) name or part of a name.


Note:  This API call can also be found under the requesttype of "Stats".


JSON Request Example:     

{
  "username": "JohnDoe",
  "usertoken": "abc123abc123abc123abc123",
  "requesttype": "Newsletters",
  "requestmethod": "GetNewsletterStatIds",
  "details": {
    /* exactly one of name, startswith, endswith, contains is required */
    "name": "{*newsletter_name*}",
    "startswith": "{*beginning_of_newsletter_name*}",
    "endswith": "{*end_of_newsletter_name*}",
    "contains": "{*string_found_within_newsletter_name*}"
  }
}
Null


"json_request"  element


Field NameDescription
usernameUsername used to login to Pinpointe
usertokenUnique token assigned to Pinpointe account
requesttypeNewsletters
requestmethodGetNewsletterStatIds


"details" element


NOTE: The following fields are case sensitive. 

As noted in the call code example, exactly one of either "name", "startswith", "endswith" or "contains" is required.


Please note: After selecting which element to use as the search parameter (name, startswith, endswith, contains), the other unused elements should be deleted.  


Field Name
Description
name
The full name of the newsletter
startswithProvide one to 'n' starting characters of newsletter name
endswithProvide one to 'n' ending characters of newsletter name
containsProvide one to 'n' characters of newsletter name


Successful Response:


"response" element


Field NameDescription
statusWill return SUCCESS if newsletter stat id is successfully retrieved


"response" "data" "item" element


Field NameDescription
idNewsletter ID
nameNewsletter name
statids Statistical report ID(s) for this newsletter


Unsuccessful Response:


"response" element


Field NameDescription
statusWill return FAILED if unsuccessful
errormessageText explaining why request failed