This is API documentation of Dmarc Report.

Auth

Dmarc Report supports basic HTTP token based authentication. To get API token, follow these instructions.

  1. Signup for Dmarc Report at app.dmarcreport.com.

  2. After logging in, click on your profile icon and select API Tokens from the dropdown.

  3. Click on New Api Token.

  4. Select privileges for this token and click save.

To authenticate, you need to set Authorization header with Token token=<token>.

So your Authorization header should look like:

Authorization: Token token=6fdd07dd6c3e36440cc8ae64282181ecf71f7d0437bf35b3f01f9f99eb518

Resources

Accounts
List of all accounts. Plus you can add, remove and veiw details of account.

Resource Description
GET api.dmarcreport.com/v2/accounts List accounts
POST api.dmarcreport.com/v2/accounts.json Add account
PUT api.dmarcreport.com/v2/accounts/:id.json Updates account
DELETE api.dmarcreport.com/v2/accounts/:id.json Delete account

Agg reports
List, Search and Paginate the Aggregate Reports. Plus get all the details of an individual Aggregat Report.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports.json List, Search and Paginate Aggregte Reports
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/records.json Get all the details of a Aggregte Reports records
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/:id.json Get all the details of a Aggregte Report
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/agg_report_stats Get Aggregate Report Stats of domain

Account domains
List of all domains in your account. Plus you can add, remove and veiw details of domains in your account.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/domain_accounts List domain accounts
GET api.dmarcreport.com/v2/accounts/:account_id/domain_accounts/:id Details of domain account
POST api.dmarcreport.com/v2/accounts/:account_id/domain_accounts.json Add domains in account
DELETE api.dmarcreport.com/v2/accounts/:account_id/domain_accounts/:domain_accounts_id.json Delete domain from account

Domains
List all the domains of the user. Plus get all the details of an individual Domain.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/domains.json List of all Domains
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:id.json Get all the details of a Domain
POST api.dmarcreport.com/v2/accounts/:account_id/domains.json Add your domain

Forensic reports
List, Search and Paginate the Failure Reports. Plus get all the details of an individual Aggregate Report.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/forensic_reports.json List, Search and Paginate Failure Reports
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/forensic_reports/:id.json Get all the details of a Failure Report

Mta sts reports
List, Search and Paginate the MTA STS Reports. Plus get all the details of an individual Aggregat Report.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports.json List, Search and Paginate MTA Reports
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/mta_failure_details.json List, Search and Paginate MTA Reports
GET api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/:id.json Get all the details of a MTA Report

Postmaster account records
List and Search the Postmaster accounts. Plus get all the details of an individual Postmaster Accout domain.

Resource Description
GET api.dmarcreport.com/v2/postmaster_account_records.json Cummulative data of all domains of a Postmaster Account
GET api.dmarcreport.com/v2/postmaster_account_records/:id.json Details of a Postmaster Account domain.
GET api.dmarcreport.com/v2/postmaster_account_records/connected.json List of connected Postmaster Accounts.

Account members
List of all members in your account. Plus you can add, remove and veiw details of members in your account.

Resource Description
GET api.dmarcreport.com/v2/accounts/:account_id/user_accounts List user accounts
GET api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id Details of user account
POST api.dmarcreport.com/v2/accounts/:account_id/user_accounts.json Add user in account
PUT api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json Update user in account
DELETE api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json Delete user from account