API reference: Statistics documents the function signatures, parameters, return values, and error behavior of the Elaine HTTP API.
Note
Function availability depends on the Elaine release and enabled features. Authenticate HTTP requests with an Elaine-issued Bearer JWT.
Function overview
| array | api_getGroupStatisticsOverview ( int $ev_id ) |
| Delivers statistical performance figures on the specified recipient group. | |
| array|integer | api_getMailingStatisticsOverview ( int $nl_id ) |
| Delivers statistical performance figures on the specified, already sent mailing. |
Functions
api_getGroupStatisticsOverview
array api_getGroupStatisticsOverview( int $ev_id )
Delivers statistical performance figures on the specified recipient group.
Parameters
| int | $ev_id | Group ID |
Return Value
| array | Group statistics |
api_getMailingStatisticsOverview
array|integer api_getMailingStatisticsOverview( int $nl_id )
Delivers statistical performance figures on the specified, already sent mailing. Data is returned as associative array; the content corresponds to the statistical overview of the ELAINE interface.
Parameters
| int | $nl_id | Newsletter ID |
Return Value
| array|integer | Newsletter statistics |