Get sender queue information

Description

Get detailed information about the number of messages with different status in sender queue.

Request URL

Method: POST

https://example.com/api/v1.1/admin/senders/queue/stats/

Request parameters

Parameter	Type	Example	Required	Description
token	string	"abcdefghijklmnqrstuvwxyz"	Yes	API token
format	string	"json"	No	Response data format By default – json
id	int	12	Yes	Sender ID By default – 1
account_id	int	12	No	Account ID By default – 1
campaign_id	int	12	No	Campaign ID By default – 0
isp	string	"Gmail"	No	ISP (email provider)
group *	string	"total"	No	Message grouping mode By default – total

* "group" parameter can have these values:

• account – group messages by account
• account_campaign – group messages by campaigns within accounts
• isp – group messages by ISP
• total – do not group messages

Request example

JSON

{
    "token": "abcdefghijklmnqrstuvwxyz",
    "id": 119
}

XML

<xml>
  <token>abcdefghijklmnqrstuvwxyz</token>
  <id>119</id>
</xml>

Response example

JSON

{
    "data": [
        {
            "account_id": 306,
            "campaign_id": 4591,
            "hold": 0,
            "isp": "",
            "new": 100,
            "proc": 100,
            "retry": 0,
            "total": 200
        },
        {
            "account_id": 306,
            "campaign_id": 4914,
            "hold": 80,
            "isp": "",
            "new": 10,
            "proc": 10,
            "retry": 40,
            "total": 140
        }
    ],
    "error": 0,
    "error_text": "Successful operation"
}

XML

<xml>
  <data>
    <account_id>306</account_id>
    <campaign_id>4591</campaign_id>
    <hold>0</hold>
    <isp></isp>
    <new>100</new>
    <proc>100</proc>
    <retry>0</retry>
    <total>200</total>
  </data>
  <data>
    <account_id>306</account_id>
    <campaign_id>4914</campaign_id>
    <hold>80</hold>
    <isp></isp>
    <new>10</new>
    <proc>10</proc>
    <retry>40</retry>
    <total>140</total>
  </data>
  <error>0</error>
  <error_text>Successful operation</error_text>
</xml>

Response parameters

Parameter	Type	Description
error	int	Error code
error_text	string	Error text