|There are three optional values for this field:|
▪ “newsletter” -> (also the default should the field be omitted altogether). All sends (each
send being identified by a stat_id within Pinpointe) will be aggregated together into one
dataset for a given newsletter_id. So, if newsletter_id 25025 had been sent 11 times for
the time period being queried, the send metrics for all 11 stat_ids would be aggregated.
▪ “batch” -> This will return each send (stat_id) for a given newsletter_id. In the example
above, 11 separate datasets would be returned.
▪ “send” -> This will return a dataset for every child batch send for a given parent send
stat_id. For example, if newsletter_id had been sent twice, there would be two parent
sends, (ex: stat_id 44000 and 45000), and if each of these two sends had been sent in
three batches (ex: 44001, 44002, 44003 and 45001, 45002, 45003), this call would return
six separate datasets, each being the dataset for the respective batch send. The
aggregated stat dataset for 44000 and 44001 would NOT be returned.
If the user wishes to get the aggregated dataset for the parent send, they should set
“grouping” to “batch”, OR, user could aggregate the individual batch sends themselves
In addition, if using “send”, a dataset for each non-batched send is also returned, though
in this case there is only one ‘batch’ for that parent send.
So, following the example above, if the user had three sends for the newsletter_id (send
stat_id 44000 and 45000, sent in three separate batches each) AND had sent a non-batch
send (stat_id 46000), selecting “send” would return seven datasets: the six individual
batches for 44000 and 45000, and the dataset for 46000. A non-batched send will be
treated as its own batch send using “send”.