/v1/statistics/emailCompliance

get https://api.birddogsecurity.com/v1/statistics/emailCompliance

Retrieves statistics for email compliance exposures, including maximum risk ranks, scan dates, and counts of compliant and total sections.

Responses

Response body

object

recordCount

integer

The total number of records available.

currentPage

integer

The current page number.

totalPages

integer

The total number of pages.

pageLimit

integer

The limit of records per page.

results

array of objects

results

object

customerId

string

The ID of the customer.

customerName

string

The name of the customer.

maxRiskRank

number

The highest risk rank among email compliance exposures for the customer.

maxRiskGroup

string

The maximum risk group (informational, low, medium, high, or critical).

minScanDay

date

The date of the first scan in the data set.

maxScanDay

date

The date of the most recent scan in the data set.

compliantTrueCountPerSection

integer

The total number of exposures marked as compliant (risk rank of 0) for the section.

totalSectionCount

integer

The total number of exposures for the section.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.birddogsecurity.com/v1/statistics/emailCompliance \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200A paginated list of email compliance statistics.

401Unauthorized: API key is missing or invalid.

500Database error occurred.