Need An Email Marketing Solution For All Of Your Customers?

Partner With VerticalResponse!

getCompanySummary


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

Input

[vrtypens:getCompanySummaryArgs]

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:

  • lists
  • campaigns

Category names are case-sensitive.

Output

[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:

  • “total lists”: number of lists that haven’t been deleted
  • “email lists”: number of email lists that haven’t been deleted
  • “optin lists”: number of opt-in lists that haven’t been deleted
  • “postcard lists”: number of postcard lists that haven’t been deleted
  • “total deleted lists”: total number of lists that have been deleted
  • “deleted email lists”: number of email lists that have been deleted
  • “deleted optin lists”: number of opt-in lists that have been deleted
  • “deleted postcard lists”: number of postcard lists that have been deleted

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

Examples

Perl

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

PHP

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

Ruby

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