Customer Subuser Statistics

Statistics regarding your Customer Subusers.

Retrieve Customer Subuser Statistics

Note that you can use either the days parameter or the start_date and end_date parameter.

URI Parameter	Required	Requirements	Description
user	Yes	Customer subuser must be registered under your account	The customer subuser we are retrieving statistics from
days	No	Must be an integer greater than 0	Number of days in the past to include statistics (includes today)
start_date	No	Date must be in `YYYY-mm-dd` format and be before the end_date parameter	The start date to look up statistics
end_date	No	Date must be in `YYYY-mm-dd` format and be after the start_date parameter	The end date to look up statistics

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com`

Response

[
  {
    "date": "2009-06-20",
    "requests": 12342,
    "bounces": 12,
    "clicks": 10223,
    "opens": 9992,
    "spamreports": 5
  },
  {
    "date": "2009-06-21",
    "requests": 32342,
    "bounces": 10,
    "clicks": 14323,
    "opens": 10995,
    "spamreports": 7
  },
  {
    "date": "2009-06-22",
    "requests": 52342,
    "bounces": 11,
    "clicks": 19223,
    "opens": 12992,
    "spamreports": 2
  }
]

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com`

Response

<stats>
   <day>
      <date>2009-06-20</date>
      <requests>12342</requests>
      <bounces>12</bounces>
      <clicks>10223</clicks>
      <opens>9992</opens>
      <spamreports>5</spamreports>
   </day>
   <day>
      <date>2009-06-21</date>
      <requests>32342</requests>
      <bounces>10</bounces>
      <clicks>14323</clicks>
      <opens>10995</opens>
      <spamreports>7</spamreports>
   </day>
   <day>
      <date>2009-06-22</date>
      <requests>52342</requests>
      <bounces>11</bounces>
      <clicks>19223</clicks>
      <opens>12992</opens>
      <spamreports>2</spamreports>
   </day>
</stats>

Retrieve Aggregates

Retrieve all-time totals for your customer subuser

URI Parameter	Required	Requirements	Description
user	Yes	Customer subuser must be registered under your account	The subuser we are retrieving statistics from
aggregate	Yes	Must be set to 1	This is used to let us know that you are interested in all time totals

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&aggregate=`

Response

{
  "requests": 12342,
  "bounces": 12,
  "clicks": 10223,
  "opens": 9992,
  "spamreports": 5
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&aggregate=`

Response

<stats>
   <requests>12342</requests>
   <bounces>12</bounces>
   <clicks>10223</clicks>
   <opens>9992</opens>
   <spamreports>5</spamreports>
</stats>

Retrieve a list of all the categories used in your customer subusers account.

URI Parameter	Required	Requirements	Description
list	Yes	The value must be set to `true`	This will allow you to retrieve a list of all categories used in your customer subusers account.
user	Yes	Subuser must be registered under your account	The subuser we are retrieving category statistics from

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&list=tru`

Response

{
  "category": "categoryC"
}

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&list=tru`

Response

<categories>
   <category>categoryA</category>
   <category>categoryB</category>
   <category>categoryC</category>
</categories>

Category Statistics

Retrieve statistics broken down by category. If the category does not exist, there will be an empty result set.

Note that you can use either the days parameter or the start_date and end_date parameter.

URI Parameter	Required	Requirements	Description
category	Yes	Must be an existing category that has statistics. You can pass in an array of categories	The category you will specify to retrieve detailed stats
user	Yes	Customer subuser must be registered under you	The customer subuser we are retrieving statistics from
days	No	Must be an integer greater than 0	Number of days in the past to include statistics (Includes today)
start_date	No	Date must be in `YYYY-mm-dd` format and be before the end_date parameter	The start date to look up statistics
end_date	No	Date must be in `YYYY-mm-dd` format and be after the start_date parameter	The end date to look up statistics

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.json`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&start_date=2009-06-20&end_date=2009-06-22&category=category`

Response

[
  {
    "date": "2009-06-20",
    "category": "categoryA",
    "requests": 12342,
    "bounces": 12,
    "clicks": 10223,
    "opens": 9992,
    "spamreports": 5
  },
  {
    "date": "2009-06-21",
    "category": "categoryB",
    "requests": 32342,
    "bounces": 10,
    "clicks": 14323,
    "opens": 10995,
    "spamreports": 7
  }
]

Call

POST	`https://api.sendgrid.com/apiv2/reseller.manageSubuser.xml`
POST Data	`api_user=your_sendgrid_username&api_key=your_sendgrid_password&method=stats&user=example@example.com&start_date=2009-06-20&end_date=2009-06-22&category=category`

Response

<stats>
   <day>
      <date>2009-06-20</date>
      <category>categoryA</category>
      <requests>12342</requests>
      <bounces>12</bounces>
      <clicks>10223</clicks>
      <opens>9992</opens>
      <spamreports>5</spamreports>
   </day>
   <day>
      <date>2009-06-21</date>
      <category>categoryB</category>
      <requests>32342</requests>
      <bounces>10</bounces>
      <clicks>14323</clicks>
      <opens>10995</opens>
      <spamreports>7</spamreports>
   </day>
</stats>

Need some help?

We all do sometimes. Get help now from the Twilio SendGrid Support Team.

Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

This documentation is for the SendGrid Web API v2

Need some help?

Thank you for your feedback!

Thanks for your feedback!