getCompanySummary

Partner API Only
The getCompanySummary() method reports various summary statistics such as list count and campaign count for a company.

session_id [xsd:string] (required)

Your API session id.

company_id [xsd:int]

The id of the company whose statistics are to be retrieved.
Defaults to the id of the calling company.

categories [vrtypens:ArrayOfString] (required)

A list of categories of statistics requested. Available categories are:

Category names are case-sensitive.

[vrtypens:NVDictionary]

The output is an NVDictionary containing the company’s statistics.

If “lists” is included in the categories argument, then the following statistics will be included in the result:

If “campaigns” is included in the categories argument, then the following statistics will be included in the result:

“total email campaigns”: total number of email campaigns that haven’t been deleted
“launched email campaigns”: number of email campaigns that have been launched and not deleted
“not launched email campaigns”: number of email campaigns that have not yet been launched and have not been deleted
“total deleted email campaigns”: total number of deleted email campaigns
“deleted launched email campaigns”: number of campaigns that have been launched and have been deleted
“deleted not launched email campaigns”: number of campaigns that have not yet been launched and have been deleted

$vrapi->getCompanySummary( {
    session_id => $sid,
    categories => [ 'lists', 'campaigns' ],
} );

$vrapi->getCompanySummary( array(
    'session_id' => $sid,
    'categories' => array( 'lists', 'campaigns' ),
) );

vr.getCompanySummary({
    'session_id' => sid,
    'categories' => ['lists', 'campaigns'],
})

Need An Email Marketing Solution For All Of Your Customers?