Retrieves account or domain level inbound and outbound statistics for Email Gateway Defense.
Note that any data prior to August 1, 2020 will not be included in the results.
Endpoints
Account level: GET /beta/accounts/{account_id}/ess/statistics
Domain level: GET /beta/accounts/{account_id}/ess/domains/{domain_id | domain_name}/statistics
Request header
| Name | Required | Description | Type |
|---|---|---|---|
| access_token | Required | The access token issued by the authorization server. | String |
Path parameters
| Name | Required | Description | Data Type |
|---|---|---|---|
| account_id | Required | The Barracuda Cloud Control account ID. | String |
| domain_id | Required | The domain ID obtained from the List Domains API. | String |
| domain_name | Optional | The domain name. This can be used in place of the domain_id. | String |
Query string parameters
| Name | Required | Description | Type |
|---|---|---|---|
| type | Optional | The type of statistics category. Default value: email. | String |
| period | Optional | How frequently to display the statistics. Available options:
| String |
| count | Optional | The number of time blocks in the past to include in the results. Available options: If period is set to 1h, the count can be set from 1-168 (7 days). If period is set to 24h, the count can be set from 1-30. Default value: 30. | String |
Response
| Entry | Description | Type |
|---|---|---|
| accountId | The Barracuda Cloud Control account ID. | String |
| type | The type of statistics category. Currently, only email is supported. | String |
| count | The number of time blocks in the past to include in the results. | String |
| period | How frequently to display the statistics. | String |
| inbound | The list of objects that each represent an inbound statistic For a description of the The timestamp format is defined as ISO-8601. | Array |
| outbound | The list of objects that each represent an outbound statistic For a description of the The timestamp format is defined as ISO-8601. | Array |
A day block starts at midnight GMT for any and all users. The results will include count complete time blocks and one time block for a partial period in the hour or day.
If there are no results for a specific time period, no entry will be posted in the results.
Sample Account Level Statistics
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/statistics" \
--header "Authorization: Bearer {access_token}"Sample Response
{
"accountId": "5584599",
"type": "email",
"period": "24h",
"count": "30",
"inbound": {
"allowed:policy:_total": {
"2020-08-04T00:00:00+0000": 52,
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"allowed:policy:emailcat": {
"2020-08-04T00:00:00+0000": 52,
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"deferred:policy:_total": {
"2020-08-04T00:00:00+0000": 436766,
"2020-08-05T00:00:00+0000": 412777,
"2020-08-06T00:00:00+0000": 943,
"2020-08-07T00:00:00+0000": 833,
"2020-08-08T00:00:00+0000": 1169775,
"2020-08-09T00:00:00+0000": 329048,
"2020-08-10T00:00:00+0000": 273684
},
"deferred:policy:barracuda_realtime_system": {
"2020-08-04T00:00:00+0000": 5,
"2020-08-05T00:00:00+0000": 2,
"2020-08-07T00:00:00+0000": 2,
"2020-08-08T00:00:00+0000": 4
},
"deferred:policy:intent_analysis": {
"2020-08-04T00:00:00+0000": 12,
"2020-08-05T00:00:00+0000": 1,
"2020-08-07T00:00:00+0000": 10,
"2020-08-08T00:00:00+0000": 3,
"2020-08-09T00:00:00+0000": 2
},
"deferred:policy:message_delivery_interrupted": {
"2020-08-04T00:00:00+0000": 562,
"2020-08-05T00:00:00+0000": 740,
"2020-08-06T00:00:00+0000": 610,
"2020-08-07T00:00:00+0000": 745,
"2020-08-08T00:00:00+0000": 375,
"2020-08-09T00:00:00+0000": 398,
"2020-08-10T00:00:00+0000": 683
},
"deferred:policy:pending_scan": {
"2020-08-04T00:00:00+0000": 2,
"2020-08-05T00:00:00+0000": 2,
"2020-08-09T00:00:00+0000": 2,
"2020-08-10T00:00:00+0000": 2
},
"deferred:policy:rate_control": {
"2020-08-04T00:00:00+0000": 434123,
"2020-08-05T00:00:00+0000": 411962,
"2020-08-08T00:00:00+0000": 1169348,
"2020-08-09T00:00:00+0000": 311226,
"2020-08-10T00:00:00+0000": 272598
},
"deferred:policy:suspicious": {
"2020-08-05T00:00:00+0000": 70,
"2020-08-06T00:00:00+0000": 333,
"2020-08-07T00:00:00+0000": 76,
"2020-08-08T00:00:00+0000": 45,
"2020-08-09T00:00:00+0000": 17420,
"2020-08-10T00:00:00+0000": 401
}
},
"outbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
},
"allowed:policy:ui_delivered": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
}
}
}Sample Domain Level Statistics
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/domains/{domain_id | domain_name}/statistics" \
--header "Authorization: Bearer {access_token}"Sample Response
{
"accountId": "5584599",
"type": "email",
"period": "24h",
"count": "30",
"inbound": {
"allowed:policy:_total": {
"2020-08-04T00:00:00+0000": 52,
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"allowed:policy:emailcat": {
"2020-08-04T00:00:00+0000": 52,
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"deferred:policy:_total": {
"2020-08-04T00:00:00+0000": 436766,
"2020-08-05T00:00:00+0000": 412777,
"2020-08-06T00:00:00+0000": 943,
"2020-08-07T00:00:00+0000": 833,
"2020-08-08T00:00:00+0000": 1169775,
"2020-08-09T00:00:00+0000": 329048,
"2020-08-10T00:00:00+0000": 273684
},
"deferred:policy:barracuda_realtime_system": {
"2020-08-04T00:00:00+0000": 5,
"2020-08-05T00:00:00+0000": 2,
"2020-08-07T00:00:00+0000": 2,
"2020-08-08T00:00:00+0000": 4
},
"deferred:policy:intent_analysis": {
"2020-08-04T00:00:00+0000": 12,
"2020-08-05T00:00:00+0000": 1,
"2020-08-07T00:00:00+0000": 10,
"2020-08-08T00:00:00+0000": 3,
"2020-08-09T00:00:00+0000": 2
},
"deferred:policy:message_delivery_interrupted": {
"2020-08-04T00:00:00+0000": 562,
"2020-08-05T00:00:00+0000": 740,
"2020-08-06T00:00:00+0000": 610,
"2020-08-07T00:00:00+0000": 745,
"2020-08-08T00:00:00+0000": 375,
"2020-08-09T00:00:00+0000": 398,
"2020-08-10T00:00:00+0000": 683
},
"deferred:policy:pending_scan": {
"2020-08-04T00:00:00+0000": 2,
"2020-08-05T00:00:00+0000": 2,
"2020-08-09T00:00:00+0000": 2,
"2020-08-10T00:00:00+0000": 2
},
"deferred:policy:rate_control": {
"2020-08-04T00:00:00+0000": 434123,
"2020-08-05T00:00:00+0000": 411962,
"2020-08-08T00:00:00+0000": 1169348,
"2020-08-09T00:00:00+0000": 311226,
"2020-08-10T00:00:00+0000": 272598
},
"deferred:policy:suspicious": {
"2020-08-05T00:00:00+0000": 70,
"2020-08-06T00:00:00+0000": 333,
"2020-08-07T00:00:00+0000": 76,
"2020-08-08T00:00:00+0000": 45,
"2020-08-09T00:00:00+0000": 17420,
"2020-08-10T00:00:00+0000": 401
}
},
"outbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
},
"allowed:policy:ui_delivered": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
}
}
}Examples
Example 1: Display 3 hours ( count ) of data in 1-hour block ( period )
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/statistics?type=email&period=1h&count=3" \
--header "Authorization: Bearer {access_token}"Sample Response
{
"accountId": "5584599",
"type": "email",
"period": "1h",
"count": "3",
"inbound": {
"allowed:policy:_total": {
"2020-08-10T20:00:00+0000": 3
},
"allowed:policy:emailcat": {
"2020-08-10T20:00:00+0000": 3
},
"deferred:policy:_total": {
"2020-08-10T20:00:00+0000": 44,
"2020-08-10T21:00:00+0000": 25,
"2020-08-10T22:00:00+0000": 29,
"2020-08-10T23:00:00+0000": 2
},
"deferred:policy:message_delivery_interrupted": {
"2020-08-10T20:00:00+0000": 36,
"2020-08-10T21:00:00+0000": 18,
"2020-08-10T22:00:00+0000": 22,
"2020-08-10T23:00:00+0000": 1
},
"deferred:policy:suspicious": {
"2020-08-10T20:00:00+0000": 8,
"2020-08-10T21:00:00+0000": 7,
"2020-08-10T22:00:00+0000": 7,
"2020-08-10T23:00:00+0000": 1
}
},
"outbound": {
"allowed:policy:_total": {
"2020-08-10T20:00:00+0000": 3,
"2020-08-10T21:00:00+0000": 1,
"2020-08-10T22:00:00+0000": 5,
"2020-08-10T23:00:00+0000": 2
},
"allowed:policy:ui_delivered": {
"2020-08-10T20:00:00+0000": 3,
"2020-08-10T21:00:00+0000": 1,
"2020-08-10T22:00:00+0000": 5,
"2020-08-10T23:00:00+0000": 2
}
}
}Example 2: Display 5 days ( count ) of data in 24-hour blocks ( period )
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/statistics?type=email&period=24h&count=5" \
--header "Authorization: Bearer {access_token}"Sample Response
{
"accountId": "5584599",
"type": "email",
"period": "24h",
"count": "5",
"inbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"allowed:policy:emailcat": {
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"deferred:policy:_total": {
"2020-08-05T00:00:00+0000": 412777,
"2020-08-06T00:00:00+0000": 943,
"2020-08-07T00:00:00+0000": 833,
"2020-08-08T00:00:00+0000": 1169775,
"2020-08-09T00:00:00+0000": 329048,
"2020-08-10T00:00:00+0000": 273684
},
"deferred:policy:barracuda_realtime_system": {
"2020-08-05T00:00:00+0000": 2,
"2020-08-07T00:00:00+0000": 2,
"2020-08-08T00:00:00+0000": 4
},
"deferred:policy:intent_analysis": {
"2020-08-05T00:00:00+0000": 1,
"2020-08-07T00:00:00+0000": 10,
"2020-08-08T00:00:00+0000": 3,
"2020-08-09T00:00:00+0000": 2
},
"deferred:policy:message_delivery_interrupted": {
"2020-08-05T00:00:00+0000": 740,
"2020-08-06T00:00:00+0000": 610,
"2020-08-07T00:00:00+0000": 745,
"2020-08-08T00:00:00+0000": 375,
"2020-08-09T00:00:00+0000": 398,
"2020-08-10T00:00:00+0000": 683
},
"deferred:policy:pending_scan": {
"2020-08-05T00:00:00+0000": 2,
"2020-08-09T00:00:00+0000": 2,
"2020-08-10T00:00:00+0000": 2
},
"deferred:policy:rate_control": {
"2020-08-05T00:00:00+0000": 411962,
"2020-08-08T00:00:00+0000": 1169348,
"2020-08-09T00:00:00+0000": 311226,
"2020-08-10T00:00:00+0000": 272598
},
"deferred:policy:suspicious": {
"2020-08-05T00:00:00+0000": 70,
"2020-08-06T00:00:00+0000": 333,
"2020-08-07T00:00:00+0000": 76,
"2020-08-08T00:00:00+0000": 45,
"2020-08-09T00:00:00+0000": 17420,
"2020-08-10T00:00:00+0000": 401
}
},
"outbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
},
"allowed:policy:ui_delivered": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
}
}
}Example 3: Display 5 days ( count ) of data in 24-hour blocks ( period ) using daily as an alias for period
Sample Request
curl -X GET "https://api.barracudanetworks.com/beta/accounts/{account_id}/ess/statistics?type=email&period=daily&count=5" \
--header "Authorization: Bearer {access_token}"Sample Response
{
"accountId": "5584599",
"type": "email",
"period": "24h",
"count": "5",
"inbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"allowed:policy:emailcat": {
"2020-08-05T00:00:00+0000": 36,
"2020-08-06T00:00:00+0000": 61,
"2020-08-07T00:00:00+0000": 33,
"2020-08-08T00:00:00+0000": 38,
"2020-08-09T00:00:00+0000": 44,
"2020-08-10T00:00:00+0000": 49
},
"deferred:policy:_total": {
"2020-08-05T00:00:00+0000": 412777,
"2020-08-06T00:00:00+0000": 943,
"2020-08-07T00:00:00+0000": 833,
"2020-08-08T00:00:00+0000": 1169775,
"2020-08-09T00:00:00+0000": 329048,
"2020-08-10T00:00:00+0000": 273684
},
"deferred:policy:barracuda_realtime_system": {
"2020-08-05T00:00:00+0000": 2,
"2020-08-07T00:00:00+0000": 2,
"2020-08-08T00:00:00+0000": 4
},
"deferred:policy:intent_analysis": {
"2020-08-05T00:00:00+0000": 1,
"2020-08-07T00:00:00+0000": 10,
"2020-08-08T00:00:00+0000": 3,
"2020-08-09T00:00:00+0000": 2
},
"deferred:policy:message_delivery_interrupted": {
"2020-08-05T00:00:00+0000": 740,
"2020-08-06T00:00:00+0000": 610,
"2020-08-07T00:00:00+0000": 745,
"2020-08-08T00:00:00+0000": 375,
"2020-08-09T00:00:00+0000": 398,
"2020-08-10T00:00:00+0000": 683
},
"deferred:policy:pending_scan": {
"2020-08-05T00:00:00+0000": 2,
"2020-08-09T00:00:00+0000": 2,
"2020-08-10T00:00:00+0000": 2
},
"deferred:policy:rate_control": {
"2020-08-05T00:00:00+0000": 411962,
"2020-08-08T00:00:00+0000": 1169348,
"2020-08-09T00:00:00+0000": 311226,
"2020-08-10T00:00:00+0000": 272598
},
"deferred:policy:suspicious": {
"2020-08-05T00:00:00+0000": 70,
"2020-08-06T00:00:00+0000": 333,
"2020-08-07T00:00:00+0000": 76,
"2020-08-08T00:00:00+0000": 45,
"2020-08-09T00:00:00+0000": 17420,
"2020-08-10T00:00:00+0000": 401
}
},
"outbound": {
"allowed:policy:_total": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
},
"allowed:policy:ui_delivered": {
"2020-08-05T00:00:00+0000": 4,
"2020-08-06T00:00:00+0000": 12,
"2020-08-07T00:00:00+0000": 7,
"2020-08-08T00:00:00+0000": 4,
"2020-08-09T00:00:00+0000": 3,
"2020-08-10T00:00:00+0000": 17
}
}
}