Table of Contents:
Table of Contents minLevel 2
Intro
| Info |
|---|
This is the primary Aggregated reports API method. All the Analytics reports one finds in the Ongage UI, such as the Aggregate report, Matrix report, Transactional, etc. are all generated with this API method! |
Note: Notice that in each API call you must provide the List ID that you are working on, otherwise the default List ID will be used.
Methods Summary
POST /api/reports/query
Description
This method fetches reports data from "mailing_data". Those residing under the Analytics in the UI of your account.
...
Only the following aggregation function functions are allowed and only on regular fields (aggregation functions are not allowed on virtual fields)and virtual fields. They can't be used in Group.
- max
- min
- count
- sum
You may use this function in select, filter , group and order.
e.g.
| Code Block |
|---|
select: [ ["min(schedule_date)", "min_schedule_date"], [ "sum(clicks)", "sum_of_clicks" ] ] |
...
Ongage\ResourceBundle\Model\Exception\InvalidData
Examples
Example - Retrieve Stats from All Lists
...