Message Statistics
GET {{baseUrl}}/messagesentstatistics/?AllMessages=<>&CampaignID=<>&CampaignStatus=<>&Contact=<>&ContactsList=<>&CustomCampaign=<>&From=<>&FromDomain=<>&FromID=<>&FromTS=<>&FromType=<>&IsDeleted=<>&IsNewsletterTool=<>&IsStarred=<>&MessageStatus=<>&Period=<>&ShowExtraData=<>&ToTS=<>
Lists the message statistics.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
AllMessages | string | Retrieve all messages. Normally, only the first message of each campaign is retrieved.nn n [ Type TBooleanFilter ] | |
CampaignID | string | Unique numerical ID for this object.nn n [ Type Int64 ] | |
CampaignStatus | string | Only retrieve campaigns with status equal to specified value.nn n [ Type SmallInt ] | |
Contact | string | Only retrieve message resources for which Contact ID equals the specified value.nn n [ Type Int64 ] | |
ContactsList | string | Only retrieve campaigns sent to specified Contacts list.nn n [ Type Int64 ] | |
CustomCampaign | string | Only retrieve campaigns with given Custom Value.nn n [ Type AnsiString ] | |
From | string | Only retrieve campaigns with given From header.nn n [ Type AnsiString ] | |
FromDomain | string | Only retrieve campaigns with given domain in From header.nn n [ Type AnsiString ] | |
FromID | string | Only retrieve campaigns with this sender ID.nn n [ Type Int64 ] | |
FromTS | string | Only retrieve campaigns with SendStartAt after this timestamp.nn n [ Type TRFC3339DateTime ] | |
FromType | string | Only retrieve campaigns with FromType equal to specified value.nn n [ Type LongInt ] | |
IsDeleted | string | Only retrieve campaigns where isDeleted matches the specified value.nn n [ Type TBooleanFilter ] | |
IsNewsletterTool | string | Only retrieve campaigns which were started by the newsletter tool.nn n [ Type TBooleanFilter ] | |
IsStarred | string | Only retrieve campaigns which were marked as starred.nn n [ Type TBooleanFilter ] | |
MessageStatus | string | Only retrieve messages with status equal to specified value.nn n [ Type TMessageStatus ] | |
Period | string | Set FromTS and ToTS timestamps to beginning of indicated period and current timestamp, respectively.nn n [ Type AnsiString ] | |
ShowExtraData | string | [ Type TBooleanFilter ] | |
ToTS | string | Only retrieve campaigns with SendStartAt timestamp less than the specified value.nn n [ Type TRFC3339DateTime ] |