{"docs":{"name":"Dmarc Report","info":"\n\u003cp\u003eThis is API documentation of \u003cstrong\u003eDmarc Report\u003c/strong\u003e.\u003c/p\u003e\n\n\u003ch3 id=\"auth\"\u003eAuth\u003c/h3\u003e\n\n\u003cp\u003e\u003cstrong\u003eDmarc Report\u003c/strong\u003e supports basic HTTP token based authentication. To get API token, follow these instructions.\u003c/p\u003e\n\n\u003col\u003e\n\u003cli\u003e\n\u003cp\u003eSignup for \u003cstrong\u003eDmarc Report\u003c/strong\u003e at \u003ccode\u003eapp.dmarcreport.com\u003c/code\u003e.\u003c/p\u003e\n\u003c/li\u003e\n\n\u003cli\u003e\n\u003cp\u003eAfter logging in, click on your profile icon and select \u003ccode\u003eAPI Tokens\u003c/code\u003e from the dropdown.\u003c/p\u003e\n\u003c/li\u003e\n\n\u003cli\u003e\n\u003cp\u003eClick on \u003ccode\u003eNew Api Token\u003c/code\u003e.\u003c/p\u003e\n\u003c/li\u003e\n\n\u003cli\u003e\n\u003cp\u003eSelect privileges for this token and click save.\u003c/p\u003e\n\u003c/li\u003e\n\u003c/ol\u003e\n\n\u003cp\u003eTo authenticate, you need to set \u003ccode\u003eAuthorization\u003c/code\u003e header with \u003ccode\u003eToken token=\u0026lt;token\u0026gt;\u003c/code\u003e.\u003c/p\u003e\n\n\u003cp\u003eSo your \u003ccode\u003eAuthorization\u003c/code\u003e header should look like:\u003c/p\u003e\n\n\u003cp\u003e\u003ccode\u003e\n  Authorization: Token token=6fdd07dd6c3e36440cc8ae64282181ecf71f7d0437bf35b3f01f9f99eb518\n\u003c/code\u003e\u003c/p\u003e\n","copyright":null,"doc_url":"/api/2.0","api_url":"https://api.dmarcreport.com","resources":{"accounts":{"doc_url":"/api/2.0/accounts","id":"accounts","api_url":"https://api.dmarcreport.com","name":"Accounts","short_description":"          List of all accounts.\n          Plus you can add, remove and veiw details of account.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/accounts/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts","http_method":"GET","short_description":"List accounts","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"note\": \"When updating or deleting an account, you can use either the 'id' (numeric) or 'slug' in the URL parameter. For example: PUT /v2/accounts/1473 or PUT /v2/accounts/my-team\",\n    \"owned_accounts\": [\n        {\n            \"id\": 1462,\n            \"title\": \"Default\",\n            \"slug\": \"default-16243a33-8c11-4989-85e1-0b4a09943a05\",\n            \"created_at\": \"2023-02-22T08:59:26.246Z\",\n            \"updated_at\": \"2023-02-22T08:59:26.246Z\",\n            \"user_id\": 1\n        },\n        {\n            \"id\": 1473,\n            \"title\": \"QA testing update\",\n            \"slug\": \"qa-testing\",\n            \"created_at\": \"2023-02-23T13:10:03.072Z\",\n            \"updated_at\": \"2023-04-07T06:44:16.693Z\",\n            \"user_id\": 1\n        }\n\n    ],\n    \"accounts\": [\n        {\n            \"id\": 1487,\n            \"title\": \"testingNew\",\n            \"slug\": \"testingnew\",\n            \"created_at\": \"2023-03-01T11:09:29.357Z\",\n            \"updated_at\": \"2023-03-01T11:09:29.357Z\",\n            \"user_id\": 1\n        },\n        {\n            \"id\": 1488,\n            \"title\": \"testing\",\n            \"slug\": \"testing-ff8ed30a-1b65-4a89-bd22-19d358a1a9bc\",\n            \"created_at\": \"2023-03-01T11:09:29.455Z\",\n            \"updated_at\": \"2023-03-01T11:09:29.455Z\",\n            \"user_id\": 1\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/accounts/create","name":"create","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts.json","http_method":"POST","short_description":"Add account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"account","full_name":"account","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"title","full_name":"account[title]","description":"\n\u003cp\u003etitle of account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/accounts/update","name":"update","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:id.json","http_method":"PUT","short_description":"Updates account","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eThe :id parameter can be either the numeric ID or the slug of the account\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID (numeric, e.g., “1473”) or slug (e.g., “my-team”)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"account","full_name":"account","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"title","full_name":"account[title]","description":"\n\u003cp\u003eTitle of team\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/accounts/destroy","name":"destroy","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:id.json","http_method":"DELETE","short_description":"Delete account","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eThe :id parameter can be either the numeric ID or the slug of the account\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eAccount ID (numeric, e.g., “1473”) or slug (e.g., “my-team”)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"agg_reports":{"doc_url":"/api/2.0/agg_reports","id":"agg_reports","api_url":"https://api.dmarcreport.com","name":"Agg reports","short_description":"          List, Search and Paginate the Aggregate Reports.\n          Plus get all the details of an individual Aggregat Report.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/agg_reports/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports.json","http_method":"GET","short_description":"List, Search and Paginate Aggregte Reports","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"org_name_eq","full_name":"q[org_name_eq]","description":"\n\u003cp\u003eSearch by Reporter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_begin_gteq","full_name":"q[date_begin_gteq]","description":"\n\u003cp\u003eSearch by date begin, Format: YYYY-MM-DD\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"date_begin_lteq","full_name":"q[date_begin_lteq]","description":"\n\u003cp\u003eSearch by date end, Format: YYYY-MM-DD\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage Number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eEntries per page.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"reports\": [\n    {\n      \"id\": 1,\n      \"raw_xml\": \"\u003c?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?\u003e...\",\n      \"org_name\": \"google.com\",\n      \"email\": \"noreply-dmarc-support@google.com\",\n      \"extra_contact_info\": \"https://support.google.com/a/answer/2466580\",\n      \"report_id\": \"1627703331531660819\",\n      \"date_begin\": \"2019-02-10T00:00:00.000Z\",\n      \"date_end\": \"2019-02-10T23:59:59.000Z\",\n      \"policy_domain\": \"twlnet.com\",\n      \"dkim_alignment\": \"s\",\n      \"spf_alignment\": \"s\",\n      \"domain_policy\": \"reject\",\n      \"subdomain_policy\": \"reject\",\n      \"percentage\": 100,\n      \"domain_id\": 1,\n      \"created_at\": \"2019-10-10T11:47:11.613Z\",\n      \"updated_at\": \"2019-10-10T11:47:11.613Z\",\n      \"records_count\": null,\n      \"report_email_message_id\": null\n    },\n    {\n      \"id\": 2,\n      \"raw_xml\": \"\u003c?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?\u003e...\",\n      \"org_name\": \"google.com\",\n      \"email\": \"noreply-dmarc-support@google.com\",\n      \"extra_contact_info\": \"https://support.google.com/a/answer/2466580\",\n      \"report_id\": \"949348866075514174\",\n      \"date_begin\": \"2019-02-12T00:00:00.000Z\",\n      \"date_end\": \"2019-02-12T23:59:59.000Z\",\n      \"policy_domain\": \"borschow.com\",\n      \"dkim_alignment\": \"r\",\n      \"spf_alignment\": \"r\",\n      \"domain_policy\": \"reject\",\n      \"subdomain_policy\": \"reject\",\n      \"percentage\": 100,\n      \"domain_id\": 1,\n      \"created_at\": \"2019-10-10T11:48:07.386Z\",\n      \"updated_at\": \"2019-10-10T11:48:07.386Z\",\n      \"records_count\": null,\n      \"report_email_message_id\": null\n    },\n    ...\n  ],\n  \"meta\": {\n    \"total_reports\": 5,\n    \"current_page\": 1,\n    \"per_page\": 25,\n    \"total_pages\": 2\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/agg_reports/records","name":"records","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/records.json","http_method":"GET","short_description":"Get all the details of a Aggregte Reports records","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"agg_report_date_begin_gteq","full_name":"q[agg_report_date_begin_gteq]","description":"\n\u003cp\u003eSearch by start date of agg report format: “mm-dd-yyyy”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"agg_report_date_end_gteq","full_name":"q[agg_report_date_end_gteq]","description":"\n\u003cp\u003eSearch by end date of agg report format: “mm-dd-yyyy”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"agg_report_org_name_eq","full_name":"q[agg_report_org_name_eq]","description":"\n\u003cp\u003eSearch by search by reporter\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip_address_source_ip_eq","full_name":"q[ip_address_source_ip_eq]","description":"\n\u003cp\u003eSearch by source ip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip_address_ptr_eq","full_name":"q[ip_address_ptr_eq]","description":"\n\u003cp\u003eSearch by PTR\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip_address_country_eq","full_name":"q[ip_address_country_eq]","description":"\n\u003cp\u003eSearch by country alpha2 code e.g. “us” for “United States of America”\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"count_eq","full_name":"q[count_eq]","description":"\n\u003cp\u003eSearch by for Volume\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"disposition_eq","full_name":"q[disposition_eq]","description":"\n\u003cp\u003eSearch by Applied Policy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003equarantine\u003c/code\u003e, \u003ccode\u003ereject\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"spf_alignment_eq","full_name":"q[spf_alignment_eq]","description":"\n\u003cp\u003eSearch by SPF Alignment: true for Aligned, false for Unaligned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"spf_status_eq","full_name":"q[spf_status_eq]","description":"\n\u003cp\u003eSearch by SPF\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epass\u003c/code\u003e, \u003ccode\u003efail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"spf_result_eq","full_name":"q[spf_result_eq]","description":"\n\u003cp\u003eSearch by SPF Auth Result\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003eneutral\u003c/code\u003e, \u003ccode\u003epass\u003c/code\u003e, \u003ccode\u003efail\u003c/code\u003e, \u003ccode\u003esoftfail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"spf_domain_eq","full_name":"q[spf_domain_eq]","description":"\n\u003cp\u003eSearch by SPF Domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"spf_domain_eq","full_name":"q[spf_domain_eq]","description":"\n\u003cp\u003eSearch by SPF Auth Scope\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reason_eq","full_name":"q[reason_eq]","description":"\n\u003cp\u003eSearch by Policy Override Reason\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003eforwarded\u003c/code\u003e, \u003ccode\u003esampled_out\u003c/code\u003e, \u003ccode\u003etrusted_forwarder\u003c/code\u003e, \u003ccode\u003emailing_list\u003c/code\u003e, \u003ccode\u003elocal_policy\u003c/code\u003e, \u003ccode\u003eother\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dkim_alignment_eq","full_name":"q[dkim_alignment_eq]","description":"\n\u003cp\u003eSearch by DKIM Alignment: true for Aligned, false for Unaligned\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dkim_status_eq","full_name":"q[dkim_status_eq]","description":"\n\u003cp\u003eSearch by DKIM\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epass\u003c/code\u003e, \u003ccode\u003efail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dkims_result_eq","full_name":"q[dkims_result_eq]","description":"\n\u003cp\u003eSearch by DKIM Auth result\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003eneutral\u003c/code\u003e, \u003ccode\u003epass\u003c/code\u003e, \u003ccode\u003efail\u003c/code\u003e, \u003ccode\u003esoftfail\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dkims_domain_eq","full_name":"q[dkims_domain_eq]","description":"\n\u003cp\u003eSearch by DKIM Domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dkims_selector_eq","full_name":"q[dkims_selector_eq]","description":"\n\u003cp\u003eSearch by DKIM selector\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"dmarc_compliance_eq","full_name":"q[dmarc_compliance_eq]","description":"\n\u003cp\u003eSearch by DMARC Compliance: 0 for complaint, 1 for non compliant and 2 for forwarded\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e0\u003c/code\u003e, \u003ccode\u003e1\u003c/code\u003e, \u003ccode\u003e2\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage Number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eEntries per page.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"records\": [\n    {\n      \"id\": 1,\n      \"count\": 1,\n      \"disposition\": \"none\",\n      \"dkim_status\": \"pass\",\n      \"spf_status\": \"pass\",\n      \"reason\": \"\",\n      \"org_name\": \"google.com\",\n      \"header_from\": \"\",\n      \"dmarc_compliance\": \"\",\n      \"ip_address\": {\n        \"id\": 3,\n        \"sane_source_ip\": \"87.106.127.28\",\n        \"blacklisted\": 0, // Tells you if ip is blacklisted in how-many lists.\n        \"ptr\": \"ec2-52-30-166-6.eu-west-1.compute.amazonaws.com\",\n        \"country\": \"de\"\n      }\n      \"auth_results\": [\n        {\n          \"id\": 1,\n          \"type\": \"Dkim\",\n          \"domain\": \"twlnet.com\",\n          \"result\": \"pass\",\n          \"selector\": \"201810\"\n        },\n        {\n          \"id\": 2,\n          \"type\": \"Spf\",\n          \"domain\": \"twlnet.com\",\n          \"result\": \"pass\",\n          \"selector\": \"\"\n        }\n      ]\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/agg_reports/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/:id.json","http_method":"GET","short_description":"Get all the details of a Aggregte Report","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n  \"id\": 1,\n  \"raw_xml\": \"\u003c?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?\u003e...\",\n  \"report_id\": \"1627703331531660819\",\n  \"org_name\": \"google.com\",\n  \"email\": \"noreply-dmarc-support@google.com\",\n  \"extra_contact_info\": \"https://support.google.com/a/answer/2466580\",\n  \"date_begin\": \"2019-02-10T00:00:00.000Z\",\n  \"date_end\": \"2019-02-10T23:59:59.000Z\",\n  \"policy_domain\": \"twlnet.com\",\n  \"dkim_alignment\": \"s\",\n  \"spf_alignment\": \"s\",\n  \"domain_policy\": \"reject\",\n  \"subdomain_policy\": \"reject\",\n  \"percentage\": 100,\n  \"domain_id\": 1,\n  \"records\": [\n    {\n      \"id\": 1,\n      \"count\": 1,\n      \"disposition\": \"none\",\n      \"dkim_status\": \"pass\",\n      \"spf_status\": \"pass\",\n      \"reason\": \"\",\n      \"header_from\": \"\",\n      \"ip_address\": {\n        \"id\": 3,\n        \"sane_source_ip\": \"87.106.127.28\",\n        \"blacklisted\": 0, // Tells you if ip is blacklisted in how-many lists.\n        \"ptr\": \"ec2-52-30-166-6.eu-west-1.compute.amazonaws.com\",\n        \"country\": \"de\"\n      }\n      \"auth_results\": [\n        {\n          \"id\": 1,\n          \"type\": \"Dkim\",\n          \"domain\": \"twlnet.com\",\n          \"result\": \"pass\",\n          \"selector\": \"201810\"\n        },\n        {\n          \"id\": 2,\n          \"type\": \"Spf\",\n          \"domain\": \"twlnet.com\",\n          \"result\": \"pass\",\n          \"selector\": \"\"\n        }\n      ]\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/agg_reports/agg_report_stats","name":"agg_report_stats","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/agg_reports/agg_report_stats","http_method":"GET","short_description":"Get Aggregate Report Stats of domain","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_date","full_name":"q[start_date]","description":"\n\u003cp\u003eSearch by date begin, Format: YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"end_date","full_name":"q[end_date]","description":"\n\u003cp\u003eSearch by date end, Format: YYYY-MM-DD\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"filter","full_name":"filter","description":"\n\u003cp\u003eSearch by filter, Format: “last_7_days, last_10_days, last_15_days, last_30_days\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"compliant\": 4174,\n  \"non_compliant\": 166,\n  \"forwarded\": 1,\n  \"total\": 4355,\n  \"none\": 4188,\n  \"quarantine\": 1,\n  \"reject\": 166\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"domain_accounts":{"doc_url":"/api/2.0/domain_accounts","id":"domain_accounts","api_url":"https://api.dmarcreport.com","name":"Account domains","short_description":"          List of all domains in your account.\n          Plus you can add, remove and veiw details of domains in your account.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/domain_accounts/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domain_accounts","http_method":"GET","short_description":"List domain accounts","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"owner_email\": \"abc@xyz.org\",\n    \"account_managements\": [\n        {\n            \"id\": 116,\n            \"account_id\": 13,\n            \"account_title\": \"team1\",\n            \"domain_id\": 2595,\n            \"domain_address\": \"api-v3.com\",\n            \"timestamp\": null\n        },\n        {\n            \"id\": 117,\n            \"account_id\": 13,\n            \"account_title\": \"team1\",\n            \"domain_id\": 2597,\n            \"domain_address\": \"api.com\",\n            \"timestamp\": null\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domain_accounts/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domain_accounts/:id","http_method":"GET","short_description":"Details of domain account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"id\": 11,\n    \"domain_id\": 255,\n    \"account_id\": 184,\n    \"timestamp\": null\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domain_accounts/create","name":"create","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domain_accounts.json","http_method":"POST","short_description":"Add domains in account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"domain_account","full_name":"domain_account","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"account_attributes","full_name":"domain_account[account_attributes]","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"id","full_name":"domain_account[account_attributes][id]","description":"\n\u003cp\u003eid of account, in which you want to add domains\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domain_ids","full_name":"domain_account[account_attributes][domain_ids]","description":"\n\u003cp\u003eids of domain you want to add in this account.\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domain_accounts/destroy","name":"destroy","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domain_accounts/:domain_accounts_id.json","http_method":"DELETE","short_description":"Delete domain from account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"domains":{"doc_url":"/api/2.0/domains","id":"domains","api_url":"https://api.dmarcreport.com","name":"Domains","short_description":"          List all the domains of the user. Plus get all the details of an individual Domain.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/domains/all_domains","name":"all_domains","apis":[{"api_url":"https://api.dmarcreport.com/v2/all_domains.json","http_method":"GET","short_description":"List of all Domains","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns a list of all domains across all accounts for the authenticated user.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eparked_domain\u003c/code\u003e (boolean): Indicates if the domain is parked (true) or live (false). Parked domains have limited message volume. - \u003ccode\u003etags\u003c/code\u003e (array): Array of tag objects associated with the domain, each containing id, name, and color.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"domains\": [\n        {\n            \"id\": 2593,\n            \"user_id\": 1,\n            \"address\": \"123.com\",\n            \"slug\": \"123-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": null,\n            \"dmarc_status\": \"dmarc_record_published\",\n            \"mta_sts_status\": \"mta_sts_inactive\",\n            \"parked_domain\": false,\n            \"created_at\": \"2023-03-31T11:49:04.099Z\",\n            \"updated_at\": \"2023-04-06T16:00:41.258Z\",\n            \"tags\": [\n                {\n                    \"id\": 1,\n                    \"name\": \"Production\",\n                    \"color\": \"#3B82F6\"\n                }\n            ]\n        },\n        {\n            \"id\": 2503,\n            \"user_id\": 1,\n            \"address\": \"sampledomain.com\",\n            \"slug\": \"sampledomain-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": false,\n            \"dmarc_status\": \"dmarc_inactive\",\n            \"mta_sts_status\": \"mta_sts_inactive\",\n            \"parked_domain\": true,\n            \"created_at\": \"2022-04-15T11:05:05.212Z\",\n            \"updated_at\": \"2023-04-06T16:00:26.839Z\",\n            \"tags\": []\n        },\n        {\n            \"id\": 2596,\n            \"user_id\": 1,\n            \"address\": \"dmarcreport.com\",\n            \"slug\": \"dmarcreport-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": true,\n            \"dmarc_status\": \"dmarc_record_published\",\n            \"mta_sts_status\": \"mta_sts_active\",\n            \"parked_domain\": false,\n            \"created_at\": \"2022-04-15T11:05:05.212Z\",\n            \"updated_at\": \"2023-04-06T16:00:26.839Z\",\n            \"tags\": [\n                {\n                    \"id\": 2,\n                    \"name\": \"Client-A\",\n                    \"color\": \"#10B981\"\n                },\n                {\n                    \"id\": 3,\n                    \"name\": \"Enterprise\",\n                    \"color\": \"#F59E0B\"\n                }\n            ]\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains.json","http_method":"GET","short_description":"List of all domains in given account","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns a list of all domains in the specified account.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eparked_domain\u003c/code\u003e (boolean): Indicates if the domain is parked (true) or live (false). Parked domains have limited message volume. - \u003ccode\u003etags\u003c/code\u003e (array): Array of tag objects associated with the domain, each containing id, name, and color.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"domains\": [\n        {\n            \"id\": 2593,\n            \"user_id\": 1,\n            \"address\": \"123.com\",\n            \"slug\": \"123-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": null,\n            \"dmarc_status\": \"dmarc_record_published\",\n            \"mta_sts_status\": \"mta_sts_inactive\",\n            \"parked_domain\": false,\n            \"created_at\": \"2023-03-31T11:49:04.099Z\",\n            \"updated_at\": \"2023-04-06T16:00:41.258Z\",\n            \"tags\": [\n                {\n                    \"id\": 1,\n                    \"name\": \"Production\",\n                    \"color\": \"#3B82F6\"\n                }\n            ]\n        },\n        {\n            \"id\": 2503,\n            \"user_id\": 1,\n            \"address\": \"sampledomain.com\",\n            \"slug\": \"sampledomain-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": false,\n            \"dmarc_status\": \"dmarc_inactive\",\n            \"mta_sts_status\": \"mta_sts_inactive\",\n            \"parked_domain\": true,\n            \"created_at\": \"2022-04-15T11:05:05.212Z\",\n            \"updated_at\": \"2023-04-06T16:00:26.839Z\",\n            \"tags\": []\n        },\n        {\n            \"id\": 2596,\n            \"user_id\": 1,\n            \"address\": \"dmarcreport.com\",\n            \"slug\": \"dmarcreport-com\",\n            \"rua_report\": true,\n            \"ruf_report\": true,\n            \"mta_sts_report\": true,\n            \"dmarc_status\": \"dmarc_record_published\",\n            \"mta_sts_status\": \"mta_sts_active\",\n            \"parked_domain\": false,\n            \"created_at\": \"2022-04-15T11:05:05.212Z\",\n            \"updated_at\": \"2023-04-06T16:00:26.839Z\",\n            \"tags\": [\n                {\n                    \"id\": 2,\n                    \"name\": \"Client-A\",\n                    \"color\": \"#10B981\"\n                },\n                {\n                    \"id\": 3,\n                    \"name\": \"Enterprise\",\n                    \"color\": \"#F59E0B\"\n                }\n            ]\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id.json","http_method":"GET","short_description":"Get all the details of a Domain","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns detailed information about a specific domain.\u003c/p\u003e\n\n\u003cp\u003eThe :id parameter can be either the numeric ID or the slug of the domain.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eparked_domain\u003c/code\u003e (boolean): Indicates if the domain is parked (true) or live (false). Parked domains have limited message volume. - \u003ccode\u003etags\u003c/code\u003e (array): Array of tag objects associated with the domain, each containing id, name, and color.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eDomain ID (numeric, e.g., “123”) or slug (e.g., “example-com”)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n    \"id\": 16,\n    \"user_id\": 1,\n    \"address\": \"abc.com\",\n    \"slug\": \"abc-com\",\n    \"rua_report\": true,\n    \"ruf_report\": true,\n    \"mta_sts_report\": true,\n    \"dmarc_status\": \"dmarc_active\",\n    \"mta_sts_status\": \"mta_sts_active\",\n    \"parked_domain\": false,\n    \"created_at\": \"2020-04-21T23:33:47.526Z\",\n    \"updated_at\": \"2023-04-06T16:00:24.086Z\",\n    \"tags\": [\n        {\n            \"id\": 1,\n            \"name\": \"Production\",\n            \"color\": \"#3B82F6\"\n        },\n        {\n            \"id\": 2,\n            \"name\": \"Client-A\",\n            \"color\": \"#10B981\"\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/create","name":"create","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains.json","http_method":"POST","short_description":"Add your domain","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eCreates a new domain in the specified account.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eParked Domains:\u003c/strong\u003e Set \u003ccode\u003eparked_domain: true\u003c/code\u003e to create a parked domain. Parked domains have limited message volume and are useful for domains that don’t actively send email. Requires parked domain quota in your subscription.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eparked_domain\u003c/code\u003e (boolean): Indicates if the domain is parked or live - \u003ccode\u003eparked_domain_credits\u003c/code\u003e (integer): Message credits remaining (only for parked domains) - \u003ccode\u003eparked_domain_status\u003c/code\u003e (string): Status of parked domain (only for parked domains) - \u003ccode\u003etags\u003c/code\u003e (array): Array of tag objects associated with the domain\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"address","full_name":"domain[address]","description":"\n\u003cp\u003eAddress of your domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"rua_report","full_name":"domain[rua_report]","description":"\n\u003cp\u003eReceives RUA Report against your domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ruf_report","full_name":"domain[ruf_report]","description":"\n\u003cp\u003eReceives RUF Report against your domain\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mta_sts_report","full_name":"domain[mta_sts_report]","description":"\n\u003cp\u003eReceives MTA-STS Report against your domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"parked_domain","full_name":"domain[parked_domain]","description":"\n\u003cp\u003eSet to true to create a parked domain with limited message volume (requires parked domain quota)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tag_ids","full_name":"domain[tag_ids]","description":"\n\u003cp\u003eArray of tag IDs to attach to the domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"tag_names","full_name":"domain[tag_names]","description":"\n\u003cp\u003eArray of tag names to attach to the domain (must exist)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"mta_sts_policy","full_name":"domain[mta_sts_policy]","description":"","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"mode","full_name":"domain[mta_sts_policy][mode]","description":"\n\u003cp\u003ePolicy Mode\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etesting\u003c/code\u003e, \u003ccode\u003eenforce\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mx","full_name":"domain[mta_sts_policy][mx]","description":"\n\u003cp\u003eDetected Mail Records Separated by comma eg: custmx.cscdns.net, mail.dmarc.com\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mx_age","full_name":"domain[mta_sts_policy][mx_age]","description":"\n\u003cp\u003ePolicy Age (Valid Time in_days)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003e1_day\u003c/code\u003e, \u003ccode\u003e2_days\u003c/code\u003e, \u003ccode\u003e3_days\u003c/code\u003e, \u003ccode\u003e4_days\u003c/code\u003e, \u003ccode\u003e5_days\u003c/code\u003e, \u003ccode\u003e6_days\u003c/code\u003e, \u003ccode\u003e7_days\u003c/code\u003e, \u003ccode\u003e2_weeks\u003c/code\u003e, \u003ccode\u003e1_month\u003c/code\u003e, \u003ccode\u003e2_months\u003c/code\u003e, \u003ccode\u003e3_months\u003c/code\u003e, \u003ccode\u003e6_months\u003c/code\u003e, \u003ccode\u003e12_months\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/update","name":"update","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id.json","http_method":"PUT","short_description":"Update domain settings","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eUpdates settings for a specific domain.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eHosted Services:\u003c/strong\u003e Enable hosted DMARC or MTA-STS to have DNS records managed by our system. When enabled, the response includes CNAME records you must add to your DNS.\u003c/p\u003e\n\n\u003cul\u003e\n\u003cli\u003e\u003ccode\u003ehosted_dmarc\u003c/code\u003e: Enable hosted DMARC (requires paid plan)\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003ehosted_mta_sts\u003c/code\u003e: Enable hosted MTA-STS (requires paid plan and mta_sts_report enabled)\u003c/li\u003e\n\n\u003cli\u003e\u003ccode\u003ehosted_dmarc_config\u003c/code\u003e: Custom DMARC record (optional)\u003c/li\u003e\n\u003c/ul\u003e\n\n\u003cp\u003e\u003cstrong\u003eDMARC Record:\u003c/strong\u003e When you enable hosted DMARC, we generate a default record for you. The response includes \u003ccode\u003edefault_dmarc_record\u003c/code\u003e and \u003ccode\u003ecurrent_dmarc_config\u003c/code\u003e fields. If you want to customize the record (policy, sp, pct, etc.), provide \u003ccode\u003ehosted_dmarc_config\u003c/code\u003e but keep the RUA and RUF addresses from the default record - these are required to receive reports.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eParked Domain Restrictions:\u003c/strong\u003e - Hosted MTA-STS is not available for parked domains - Hosted DMARC for parked domains requires \u003ccode\u003ep=reject\u003c/code\u003e policy - Subdomain policy (sp) must also be \u003ccode\u003ereject\u003c/code\u003e for parked domains\u003c/p\u003e\n\n\u003cp\u003eAfter adding the CNAME records, use the verify endpoints to check propagation.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"domain","full_name":"domain","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"rua_report","full_name":"domain[rua_report]","description":"\n\u003cp\u003eReceives RUA Report against your domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ruf_report","full_name":"domain[ruf_report]","description":"\n\u003cp\u003eReceives RUF Report against your domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"mta_sts_report","full_name":"domain[mta_sts_report]","description":"\n\u003cp\u003eReceives MTA-STS Report against your domain\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hosted_dmarc","full_name":"domain[hosted_dmarc]","description":"\n\u003cp\u003eEnable hosted DMARC - DNS records managed by our system (requires paid plan)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hosted_dmarc_config","full_name":"domain[hosted_dmarc_config]","description":"\n\u003cp\u003eCustom DMARC record. Must include RUA and RUF addresses from default_dmarc_record to receive reports.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"hosted_mta_sts","full_name":"domain[hosted_mta_sts]","description":"\n\u003cp\u003eEnable hosted MTA-STS - DNS records managed by our system (requires paid plan and mta_sts_report)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/hosted_services","name":"hosted_services","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id/hosted_services.json","http_method":"GET","short_description":"Get hosted services status and CNAME records","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eReturns the current status of hosted services for a domain, including: - Whether hosted DMARC and MTA-STS are enabled - CNAME records that need to be added to DNS - Current CNAME verification status\u003c/p\u003e\n\n\u003cp\u003eUse this endpoint to get the CNAME values after enabling hosted services, and to check the current propagation status.\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/verify_hosted_dmarc","name":"verify_hosted_dmarc","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id/verify_hosted_dmarc.json","http_method":"POST","short_description":"Verify hosted DMARC setup status","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eChecks the complete status of hosted DMARC setup including CNAME propagation and Route53 TXT record.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eoverall_status\u003c/code\u003e: Overall setup status - \u003ccode\u003eready\u003c/code\u003e: All records configured and published - \u003ccode\u003eaction_required\u003c/code\u003e: User needs to add/fix CNAME records - \u003ccode\u003epending\u003c/code\u003e: System is still processing - \u003ccode\u003ecname\u003c/code\u003e: CNAME record status (user’s DNS) - \u003ccode\u003everified\u003c/code\u003e: CNAME correctly configured - \u003ccode\u003eawaiting_setup\u003c/code\u003e: User hasn’t added CNAME yet - \u003ccode\u003emisconfigured\u003c/code\u003e: CNAME exists but has wrong value - \u003ccode\u003etxt_record\u003c/code\u003e: TXT record status (our Route53) - \u003ccode\u003epublished\u003c/code\u003e: Record is live in Route53 - \u003ccode\u003equeued\u003c/code\u003e: Record creation in progress\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/verify_hosted_mta_sts","name":"verify_hosted_mta_sts","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id/verify_hosted_mta_sts.json","http_method":"POST","short_description":"Verify hosted MTA-STS setup status","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eChecks the complete status of hosted MTA-STS setup including all CNAME records, Route53 TXT records, and policy file.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eResponse includes:\u003c/strong\u003e - \u003ccode\u003eoverall_status\u003c/code\u003e: Overall setup status - \u003ccode\u003eready\u003c/code\u003e: All records configured, published, and policy file active - \u003ccode\u003eaction_required\u003c/code\u003e: User needs to add/fix CNAME records - \u003ccode\u003epending\u003c/code\u003e: System is still processing - \u003ccode\u003erecords.policy_cname\u003c/code\u003e: Policy CNAME status (mta-sts.domain.com) - \u003ccode\u003erecords.mta_sts_record\u003c/code\u003e: MTA-STS record status (_mta-sts.domain.com) - \u003ccode\u003ecname_status\u003c/code\u003e: CNAME verification status - \u003ccode\u003etxt_record_status\u003c/code\u003e: Route53 TXT record status - \u003ccode\u003erecords.tls_rpt_record\u003c/code\u003e: TLS-RPT record status (_smtp._tls.domain.com) - \u003ccode\u003ecname_status\u003c/code\u003e: CNAME verification status - \u003ccode\u003etxt_record_status\u003c/code\u003e: Route53 TXT record status - \u003ccode\u003erecords.policy_file\u003c/code\u003e: MTA-STS policy file status - \u003ccode\u003eactive\u003c/code\u003e: Policy file accessible - \u003ccode\u003epending\u003c/code\u003e: Policy file not yet created - \u003ccode\u003eunreachable\u003c/code\u003e: Unable to reach policy file\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eCNAME statuses:\u003c/strong\u003e \u003ccode\u003everified\u003c/code\u003e, \u003ccode\u003eawaiting_setup\u003c/code\u003e, \u003ccode\u003emisconfigured\u003c/code\u003e \u003cstrong\u003eTXT record statuses:\u003c/strong\u003e \u003ccode\u003epublished\u003c/code\u003e, \u003ccode\u003equeued\u003c/code\u003e\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"record","full_name":"record","description":"\n\u003cp\u003eWhich record to verify: policy, mta_sts, tls_rpt, or all (default: all)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003epolicy\u003c/code\u003e, \u003ccode\u003emta_sts\u003c/code\u003e, \u003ccode\u003etls_rpt\u003c/code\u003e, \u003ccode\u003eall\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/generate_dmarc_record","name":"generate_dmarc_record","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id/generate_dmarc_record.json","http_method":"POST","short_description":"Generate a DMARC record","deprecated":null}],"formats":["JSON"],"full_description":"\n\u003cp\u003eGenerates a DMARC record for your domain with all the options available in our UI. Our reporting addresses (RUA and RUF) are automatically included.\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eStandard DMARC Options:\u003c/strong\u003e - \u003ccode\u003ep\u003c/code\u003e (policy): How to handle emails that fail DMARC (none, quarantine, reject) - \u003ccode\u003esp\u003c/code\u003e (subdomain policy): Policy for subdomains (none, quarantine, reject) - \u003ccode\u003epct\u003c/code\u003e (percentage): Percentage of emails to apply the policy to (0-100) - \u003ccode\u003eadkim\u003c/code\u003e (DKIM alignment): How strictly to check DKIM (r=relaxed, s=strict) - \u003ccode\u003easpf\u003c/code\u003e (SPF alignment): How strictly to check SPF (r=relaxed, s=strict) - \u003ccode\u003efo\u003c/code\u003e (forensic options): When to send forensic reports (0, 1, d, s - can combine with colon) - \u003ccode\u003eadditional_rua_emails\u003c/code\u003e (array): Additional email addresses for aggregate reports - \u003ccode\u003eadditional_ruf_emails\u003c/code\u003e (array): Additional email addresses for forensic reports\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eDMARCbis Options (newer standard):\u003c/strong\u003e - \u003ccode\u003et\u003c/code\u003e (test mode): Enable test mode - reports only, no policy enforcement (y, n) - \u003ccode\u003epsd\u003c/code\u003e (public suffix domain): Is this a public suffix domain? (y, n, u=unknown) - \u003ccode\u003enp\u003c/code\u003e (non-existent subdomain policy): Policy for non-existent subdomains (none, quarantine, reject)\u003c/p\u003e\n\n\u003cp\u003e\u003cstrong\u003eForensic Options (fo) explained:\u003c/strong\u003e - \u003ccode\u003e0\u003c/code\u003e: Send report if all authentication fails (default) - \u003ccode\u003e1\u003c/code\u003e: Send report if any authentication fails - \u003ccode\u003ed\u003c/code\u003e: Send report if DKIM fails - \u003ccode\u003es\u003c/code\u003e: Send report if SPF fails - Combine with colon, e.g., “1:d:s” for multiple options\u003c/p\u003e\n","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"p","full_name":"p","description":"\n\u003cp\u003ePolicy: none (monitor), quarantine (spam folder), reject (block)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003equarantine\u003c/code\u003e, \u003ccode\u003ereject\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sp","full_name":"sp","description":"\n\u003cp\u003eSubdomain policy (optional)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003equarantine\u003c/code\u003e, \u003ccode\u003ereject\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"pct","full_name":"pct","description":"\n\u003cp\u003ePercentage of emails to apply policy (0-100)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Integer","expected_type":"numeric","metadata":null,"show":true,"validations":[]},{"name":"adkim","full_name":"adkim","description":"\n\u003cp\u003eDKIM alignment: r=relaxed (default), s=strict\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003er\u003c/code\u003e, \u003ccode\u003es\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"aspf","full_name":"aspf","description":"\n\u003cp\u003eSPF alignment: r=relaxed (default), s=strict\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003er\u003c/code\u003e, \u003ccode\u003es\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"fo","full_name":"fo","description":"\n\u003cp\u003eForensic options: 0, 1, d, s (combine with colon, e.g., “1:d”)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"additional_rua_emails","full_name":"additional_rua_emails","description":"\n\u003cp\u003eAdditional aggregate report email addresses\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"additional_ruf_emails","full_name":"additional_ruf_emails","description":"\n\u003cp\u003eAdditional forensic report email addresses\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an array of any type","expected_type":"array","metadata":null,"show":true,"validations":[]},{"name":"t","full_name":"t","description":"\n\u003cp\u003eDMARCbis: Test mode (y=yes, n=no)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"psd","full_name":"psd","description":"\n\u003cp\u003eDMARCbis: Public suffix domain (y=yes, n=no, u=unknown)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003ey\u003c/code\u003e, \u003ccode\u003en\u003c/code\u003e, \u003ccode\u003eu\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"np","full_name":"np","description":"\n\u003cp\u003eDMARCbis: Non-existent subdomain policy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003enone\u003c/code\u003e, \u003ccode\u003equarantine\u003c/code\u003e, \u003ccode\u003ereject\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"publish","full_name":"publish","description":"\n\u003cp\u003eAlso publish this record to hosted DMARC (requires hosted_dmarc enabled)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/domains/destroy","name":"destroy","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:id.json","http_method":"DELETE","short_description":"Delete a domain","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"forensic_reports":{"doc_url":"/api/2.0/forensic_reports","id":"forensic_reports","api_url":"https://api.dmarcreport.com","name":"Forensic reports","short_description":"          List, Search and Paginate the Failure Reports.\n          Plus get all the details of an individual Aggregate Report.\n","full_description":"","version":"2.0","formats":["json"],"metadata":null,"methods":[{"doc_url":"/api/2.0/forensic_reports/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/forensic_reports.json","http_method":"GET","short_description":"List, Search and Paginate Failure Reports","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"created_at_gteq","full_name":"q[created_at_gteq]","description":"\n\u003cp\u003eSearch by date begin start\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"created_at_lteq","full_name":"q[created_at_lteq]","description":"\n\u003cp\u003eSearch by date begin end\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip_address_country_eq","full_name":"q[ip_address_country_eq]","description":"\n\u003cp\u003eSearch by country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"ip_address_source_ip_eq","full_name":"q[ip_address_source_ip_eq]","description":"\n\u003cp\u003eSearch by source ip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"delivery_result","full_name":"q[delivery_result]","description":"\n\u003cp\u003eSearch by for delivery result\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"feedback_type_eq","full_name":"q[feedback_type_eq]","description":"\n\u003cp\u003eSearch by feedback type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"arrival_date_eq","full_name":"q[arrival_date_eq]","description":"\n\u003cp\u003eSearch by arrival date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"original_message_date_eq","full_name":"q[original_message_date_eq]","description":"\n\u003cp\u003eSearch by original message date\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"from_address_eq","full_name":"q[from_address_eq]","description":"\n\u003cp\u003eSearch by from address\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"message_id_eq","full_name":"q[message_id_eq]","description":"\n\u003cp\u003eSearch by message id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subject_cont","full_name":"q[subject_cont]","description":"\n\u003cp\u003eSearch by subject cont\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage Number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eEntries per page.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"reports\": [\n    {\n      \"id\": 1,\n      \"domain_id\": 1,\n      \"raw_report\": \"Feedback-Type: auth-failure\\r\\nUser-Agent: Lua/1.0\\r\\nVersion: 1.0\\r\\nOriginal-Mail-From:\\r\\nOriginal-Rcpt-To: recipient@linkedin.com\\r\\nArrival-Date: Tue, 30 Apr 2019 02:09:00 +0000\\r\\nMessage-ID: \u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\\r\\nAuthentication-Results: dmarc=fail (p=none; dis=none) header.from=example.com\\r\\nSource-IP: 10.10.10.10\\r\\nDelivery-Result: delivered\\r\\nAuth-Failure: dmarc\\r\\nReported-Domain: example.com\\r\\n\",\n      \"raw_original_message\": \"Content-Type: message/rfc822\\r\\nContent-Transfer-Encoding: 7bit\\r\\nContent-Disposition: inline\\r\\nContent-ID: \u003c5d9f1b8165398_122d2abf602d8648805f7@Zaid-XPS-13.mail\u003e\\r\\n\\r\\nReturn-Path: \u003c\u003e\\r\\nAuthentication-Results: mail516.prod.linkedin.com; iprev=pass policy.iprev=\\\"10.10.10.10\\\"; spf=neutral smtp.mailfrom=\\\"\\\" smtp.helo=\\\"mail02.someserver.com\\\"; dkim=none (message not signed) header.d=none; tls=pass (verified) key.ciphersuite=\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\" key.length=\\\"256\\\" tls.v=\\\"tlsv1.2\\\" cert.client=\\\"OU=Domain Control Validated,CN=*.someserver.com\\\" cert.clientissuer=\\\"C=GB,ST=Greater Manchester,L=Salford,O=COMODO CA Limited,CN=COMODO RSA Domain Validation Secure Server CA\\\"; dmarc=fail (p=none; dis=none) header.from=example.com\\r\\nX-OnPremExternalIP: 10.10.10.10\\r\\nReceived: from [10.10.10.10] ([10.10.10.10:4227] helo=mail02.someserver.com)\\r\\n\\tby mail516.prod.linkedin.com (envelope-from \u003c\u003e)\\r\\n\\t(ecelerity 3.6.21.53563 r(Core:3.6.21.0)) with ESMTPS (cipher=ECDHE-RSA-AES256-GCM-SHA384\\r\\n\\tsubject=\\\"/OU=Domain Control Validated/CN=*.someserver.com\\\")\\r\\n\\tid CA/91-26019-ABCDECC5; Tue, 30 Apr 2019 02:09:00 +0000\\r\\nReceived: from DENU02MS0016.someserver.loc (10.156.68.14) by\\r\\n DENU02MS0017.someserver.loc (10.10.10.9) with Microsoft SMTP Server (TLS) id\\r\\n 15.0.1367.3; Tue, 30 Apr 2019 04:09:09 +0200\\r\\nReceived: from DENU02MS0016.someserver.loc ([127.0.0.1]) by\\r\\n DENU02MS0016.someserver.loc ([10.10.10.8]) with Microsoft SMTP Server id\\r\\n 15.00.1367.000; Tue, 30 Apr 2019 04:09:09 +0200\\r\\nFrom: Sender \u003csender@example.com\u003e\\r\\nTo: LinkedIn \u003crecipient@linkedin.com\u003e\\r\\nSubject: Subject line, could be UTF8 encoded\\r\\nThread-Topic: Thread Topic line, could be UTF8 encoded\\r\\nThread-Index: AQHU/abcdW8+abcdLkClF52hP4alIaZT9XGh\\r\\nDate: Tue, 30 Apr 2019 02:09:09 +0000\\r\\nMessage-ID: \u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\\r\\nReferences: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nIn-Reply-To: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nX-MS-Has-Attach:\\r\\nX-Auto-Response-Suppress: All\\r\\nX-MS-Exchange-Inbox-Rules-Loop: sender@example.com\\r\\nX-MS-TNEF-Correlator:\\r\\nx-ms-exchange-transport-fromentityheader: Hosted\\r\\nx-ms-exchange-parent-message-id: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nauto-submitted: auto-generated\\r\\nx-ms-exchange-generated-message-source: Mailbox Rules Agent\\r\\nx-exclaimer-md-config: 11111111-1111-1111-1111-111111111111\\r\\nContent-Type: multipart/alternative;\\r\\n\\tboundary=\\\"_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\\"\\r\\nMIME-Version: 1.0\\r\\nX-Linkedin-fe: false\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\r\\nContent-Type: text/plain; charset=\\\"iso-8859-1\\\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\nAlternative\\r\\nText\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\r\\nContent-Type: text/html; charset=\\\"iso-8859-1\\\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\n\u003chtml\u003e\\r\\n\u003chead\u003e\\r\\n\u003c/head\u003e\\r\\n\u003cbody\u003e\\r\\nHTML Text\\r\\n\u003c/body\u003e\\r\\n\u003c/html\u003e\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_--\",\n      \"subject\": \"Subject line, could be UTF8 encoded\",\n      \"feedback_type\": \"abuse\",\n      \"user_agent\": \"Lua/1.0\",\n      \"auth_failure\": \"\",\n      \"arrival_date\": \"2019-04-30T02:09:09.000Z\",\n      \"from_address\": \"sender@example.com\",\n      \"message_id\": \"\u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\",\n      \"delivery_result\": \"delivered\",\n      \"original_rcpt_to\": \"recipient@linkedin.com\",\n      \"reporting_mta\": \"\",\n      \"reported_domain\": \"example.com\",\n      \"reported_uri\": \"\",\n      \"removal_recipient\": \"\",\n      \"created_at\": \"2019-10-10T11:52:33.522Z\",\n      \"updated_at\": \"2020-01-16T09:37:38.319Z\",\n      \"report_email_message_id\": null,\n      \"original_message_date\": null,\n      \"ip_address_id\": 2\n    },\n    {\n      \"id\": 2,\n      \"domain_id\": 1,\n      \"raw_report\": \"Feedback-Type: auth-failure\\r\\nUser-Agent: NtesDmarcReporter/1.0\\r\\nVersion: 1\\r\\nOriginal-Mail-From: \u003cbounces+1137616-c1ad-xsj399=163.com@email.entrata.com\u003e\\r\\nArrival-Date: Fri, 28 Sep 2018 16:48:42 +0800\\r\\nSource-IP: 167.89.69.24\\r\\nReported-Domain: cardinal.com\\r\\nOriginal-Envelope-Id: N8CowEApcUPo6q1bnXlMAA--.44392S3\\r\\nAuthentication-Results: 163.com; dkim=pass (verify result: all signatures verified) header.d=entrata.com; spf=pass smtp.mailfrom=bounces+1137616-c1ad-xsj399=163.com@email.entrata.com\\r\\nDKIM-Domain: entrata.com\\r\\nDelivery-Result: delivered\\r\\nIdentity-Alignment: spf,dkim\",\n      \"raw_original_message\": \"Content-Type: message/rfc822\\r\\nContent-Transfer-Encoding: 7bit\\r\\nContent-Disposition: attachment\\r\\n\\r\\nReceived: by filter1356p1mdw1.sendgrid.net with SMTP id filter1356p1mdw1-30359-5BADEAE4-E\\r\\n        2018-09-28 08:48:36.858842501 +0000 UTC m=+1856335.516585242\\r\\nReceived: from MTEzNzYxNg (unknown [198.190.14.10])\\r\\n\\tby ismtpd0007p1las1.sendgrid.net (SG) with HTTP id oguVx1AxQayV5Sv2nYK-rA\\r\\n\\tfor \u003csystem@entrata.com\u003e; Fri, 28 Sep 2018 08:48:36.716 +0000 (UTC)\\r\\nFrom: 700 on Washington \u003cinfo@cardinal.com\u003e\\r\\nTo: \\\"redacted@163.com\\\" \u003credacted@163.com\u003e\\r\\nSubject: Rent Reminder\\r\\nThread-Topic: Rent Reminder\\r\\nThread-Index: AQHUVwgr2Hz5Jp/wMEGsfVZ94P1m5Q==\\r\\nX-MS-Exchange-MessageSentRepresentingType: 1\\r\\nDate: Fri, 28 Sep 2018 04:48:39 -0400\\r\\nMessage-ID: \u003coguVx1AxQayV5Sv2nYK-rA@ismtpd0007p1las1.sendgrid.net\u003e\\r\\nX-MS-Has-Attach:\\r\\nX-MS-TNEF-Correlator:\\r\\nX-MS-Exchange-Organization-RecordReviewCfmType: 0\\r\\nContent-Type: text/plain; charset=\\\"us-ascii\\\"\\r\\nMIME-Version: 1.0\\r\\n\\r\\n\",\n      \"subject\": \"Rent Reminder\",\n      \"feedback_type\": \"auth-failure\",\n      \"user_agent\": \"NtesDmarcReporter/1.0\",\n      \"auth_failure\": \"\",\n      \"arrival_date\": \"2018-09-28T08:48:39.000Z\",\n      \"from_address\": \"info@cardinal.com\",\n      \"message_id\": \"\u003coguVx1AxQayV5Sv2nYK-rA@ismtpd0007p1las1.sendgrid.net\u003e\",\n      \"delivery_result\": \"delivered\",\n      \"original_rcpt_to\": \"redacted@163.com\",\n      \"reporting_mta\": \"\",\n      \"reported_domain\": \"cardinal.com\",\n      \"reported_uri\": \"\",\n      \"removal_recipient\": \"\",\n      \"created_at\": \"2019-10-10T11:53:21.754Z\",\n      \"updated_at\": \"2020-01-16T09:37:38.294Z\",\n      \"report_email_message_id\": null,\n      \"original_message_date\": null,\n      \"ip_address_id\": 1\n    },\n    {\n      \"id\": 3,\n      \"domain_id\": 1,\n      \"raw_report\": \"Feedback-Type: auth-failure\\r\\nUser-Agent: Lua/1.0\\r\\nVersion: 1.0\\r\\nOriginal-Mail-From: sharepoint@domain.de\\r\\nOriginal-Rcpt-To: peter.pan@domain.de\\r\\nArrival-Date: Mon, 01 Oct 2018 11:20:27 +0200\\r\\nMessage-ID: \u003c38.E7.30937.BD6E1BB5@ mailrelay.de\u003e\\r\\nAuthentication-Results: dmarc=fail (p=none, dis=none) header.from=domain.de\\r\\nSource-IP: 10.10.10.10\\r\\nDelivery-Result: smg-policy-action\\r\\nAuth-Failure: dmarc\\r\\nReported-Domain: domain.de\\r\\n\",\n      \"raw_original_message\": \"Content-Type: message/rfc822\\r\\nContent-Transfer-Encoding: 7bit\\r\\nContent-Disposition: inline\\r\\nContent-ID: \u003c5d9f1bc7e6b7e_13b52adc5a7d0648922f0@Zaid-XPS-13.mail\u003e\\r\\n\\r\\nReceived: from Servernameone.domain.local (Servernameone.domain.local [10.10.10.10])\\r\\n\\tby  mailrelay.de (mail.DOMAIN.de) with SMTP id 38.E7.30937.BD6E1BB5; Mon,  1 Oct 2018 11:20:27 +0200 (CEST)\\r\\nDate: 01 Oct 2018 11:20:27 +0200\\r\\nMessage-ID: \u003c38.E7.30937.BD6E1BB5@ mailrelay.de\u003e\\r\\nTo: \u003cpeter.pan@domain.de\u003e\\r\\nfrom: \\\"=?utf-8?B?SW50ZXJha3RpdmUgV2V0dGJld2VyYmVyLcOcYmVyc2ljaHQ=?=\\\" \u003csharepoint@domain.de\u003e\\r\\nSubject: Subject\\r\\nMIME-Version: 1.0\\r\\nX-Mailer: Microsoft SharePoint Foundation 2010\\r\\nContent-Type: text/html; charset=utf-8\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\n\u003chtml\u003e\u003chead\u003e\u003cbase href=3D'\\r\\nwettbewerb' /\u003e\u003c/head\u003e\u003cbody\u003e\u003c!DOCTYPE HTML PUBLIC \\\"-//W3C//DTD HTML 3.2//EN\\\"=\\r\\n\u003e\u003cHTML\u003e\u003cHEAD\u003e\u003cMETA NAME=3D\\\"Generator\\\" CONTENT=3D\\\"MS Exchange Server version=\\r\\n 08.01.0240.003\\\"\u003e\u003c/html\u003e\\r\\n\",\n      \"subject\": \"Subject\",\n      \"feedback_type\": \"auth-failure\",\n      \"user_agent\": \"Lua/1.0\",\n      \"auth_failure\": \"\",\n      \"arrival_date\": \"2018-10-01T09:20:27.000Z\",\n      \"from_address\": \"sharepoint@domain.de\",\n      \"message_id\": \"\u003c38.E7.30937.BD6E1BB5@ mailrelay.de\u003e\",\n      \"delivery_result\": \"smg-policy-action\",\n      \"original_rcpt_to\": \"peter.pan@domain.de\",\n      \"reporting_mta\": \"\",\n      \"reported_domain\": \"domain.de\",\n      \"reported_uri\": \"\",\n      \"removal_recipient\": \"\",\n      \"created_at\": \"2019-10-10T11:53:44.062Z\",\n      \"updated_at\": \"2020-01-16T09:37:38.337Z\",\n      \"report_email_message_id\": null,\n      \"original_message_date\": null,\n      \"ip_address_id\": 2\n    }\n  ],\n  \"meta\": {\n    \"total_reports\": 3,\n    \"current_page\": 1,\n    \"per_page\": 25,\n    \"total_pages\": 1\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/forensic_reports/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/forensic_reports/:id.json","http_method":"GET","short_description":"Get all the details of a Failure Report","deprecated":null}],"formats":["json"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n  \"id\": 1,\n  \"domain_id\": 1,\n  \"arrival_date\": \"2019-04-30T02:09:09.000Z\",\n  \"auth_failure\": \"\",\n  \"delivery_result\": \"delivered\",\n  \"feedback_type\": \"abuse\",\n  \"from_address\": \"sender@example.com\",\n  \"original_message_date\": null,\n  \"original_rcpt_to\": \"recipient@linkedin.com\",\n  \"raw_original_message\": \"Content-Type: message/rfc822\\r\\nContent-Transfer-Encoding: 7bit\\r\\nContent-Disposition: inline\\r\\nContent-ID: \u003c5d9f1b8165398_122d2abf602d8648805f7@Zaid-XPS-13.mail\u003e\\r\\n\\r\\nReturn-Path: \u003c\u003e\\r\\nAuthentication-Results: mail516.prod.linkedin.com; iprev=pass policy.iprev=\\\"10.10.10.10\\\"; spf=neutral smtp.mailfrom=\\\"\\\" smtp.helo=\\\"mail02.someserver.com\\\"; dkim=none (message not signed) header.d=none; tls=pass (verified) key.ciphersuite=\\\"TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384\\\" key.length=\\\"256\\\" tls.v=\\\"tlsv1.2\\\" cert.client=\\\"OU=Domain Control Validated,CN=*.someserver.com\\\" cert.clientissuer=\\\"C=GB,ST=Greater Manchester,L=Salford,O=COMODO CA Limited,CN=COMODO RSA Domain Validation Secure Server CA\\\"; dmarc=fail (p=none; dis=none) header.from=example.com\\r\\nX-OnPremExternalIP: 10.10.10.10\\r\\nReceived: from [10.10.10.10] ([10.10.10.10:4227] helo=mail02.someserver.com)\\r\\n\\tby mail516.prod.linkedin.com (envelope-from \u003c\u003e)\\r\\n\\t(ecelerity 3.6.21.53563 r(Core:3.6.21.0)) with ESMTPS (cipher=ECDHE-RSA-AES256-GCM-SHA384\\r\\n\\tsubject=\\\"/OU=Domain Control Validated/CN=*.someserver.com\\\")\\r\\n\\tid CA/91-26019-ABCDECC5; Tue, 30 Apr 2019 02:09:00 +0000\\r\\nReceived: from DENU02MS0016.someserver.loc (10.156.68.14) by\\r\\n DENU02MS0017.someserver.loc (10.10.10.9) with Microsoft SMTP Server (TLS) id\\r\\n 15.0.1367.3; Tue, 30 Apr 2019 04:09:09 +0200\\r\\nReceived: from DENU02MS0016.someserver.loc ([127.0.0.1]) by\\r\\n DENU02MS0016.someserver.loc ([10.10.10.8]) with Microsoft SMTP Server id\\r\\n 15.00.1367.000; Tue, 30 Apr 2019 04:09:09 +0200\\r\\nFrom: Sender \u003csender@example.com\u003e\\r\\nTo: LinkedIn \u003crecipient@linkedin.com\u003e\\r\\nSubject: Subject line, could be UTF8 encoded\\r\\nThread-Topic: Thread Topic line, could be UTF8 encoded\\r\\nThread-Index: AQHU/abcdW8+abcdLkClF52hP4alIaZT9XGh\\r\\nDate: Tue, 30 Apr 2019 02:09:09 +0000\\r\\nMessage-ID: \u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\\r\\nReferences: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nIn-Reply-To: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nX-MS-Has-Attach:\\r\\nX-Auto-Response-Suppress: All\\r\\nX-MS-Exchange-Inbox-Rules-Loop: sender@example.com\\r\\nX-MS-TNEF-Correlator:\\r\\nx-ms-exchange-transport-fromentityheader: Hosted\\r\\nx-ms-exchange-parent-message-id: \u003c1111111111.1111111.1111111111111.JavaMail.app@lor1-app3586.prod.linkedin.com\u003e\\r\\nauto-submitted: auto-generated\\r\\nx-ms-exchange-generated-message-source: Mailbox Rules Agent\\r\\nx-exclaimer-md-config: 11111111-1111-1111-1111-111111111111\\r\\nContent-Type: multipart/alternative;\\r\\n\\tboundary=\\\"_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\\"\\r\\nMIME-Version: 1.0\\r\\nX-Linkedin-fe: false\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\r\\nContent-Type: text/plain; charset=\\\"iso-8859-1\\\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\nAlternative\\r\\nText\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_\\r\\nContent-Type: text/html; charset=\\\"iso-8859-1\\\"\\r\\nContent-Transfer-Encoding: quoted-printable\\r\\n\\r\\n\u003chtml\u003e\\r\\n\u003chead\u003e\\r\\n\u003c/head\u003e\\r\\n\u003cbody\u003e\\r\\nHTML Text\\r\\n\u003c/body\u003e\\r\\n\u003c/html\u003e\\r\\n\\r\\n--_000_0d00000000000000000d000000000000f00000s00000someserverloc_--\",\n  \"raw_report\": \"Feedback-Type: auth-failure\\r\\nUser-Agent: Lua/1.0\\r\\nVersion: 1.0\\r\\nOriginal-Mail-From:\\r\\nOriginal-Rcpt-To: recipient@linkedin.com\\r\\nArrival-Date: Tue, 30 Apr 2019 02:09:00 +0000\\r\\nMessage-ID: \u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\\r\\nAuthentication-Results: dmarc=fail (p=none; dis=none) header.from=example.com\\r\\nSource-IP: 10.10.10.10\\r\\nDelivery-Result: delivered\\r\\nAuth-Failure: dmarc\\r\\nReported-Domain: example.com\\r\\n\",\n  \"removal_recipient\": \"\",\n  \"reported_domain\": \"example.com\",\n  \"reported_uri\": \"\",\n  \"reporting_mta\": \"\",\n  \"subject\": \"Subject line, could be UTF8 encoded\",\n  \"user_agent\": \"Lua/1.0\",\n  \"message_id\": \"\u003c01010101010101010101010101010101@ABAB01MS0016.someserver.loc\u003e\",\n  \"report_email_message_id\": null,\n  \"created_at\": \"2019-10-10T11:52:33.522Z\",\n  \"updated_at\": \"2020-01-16T09:37:38.319Z\",\n  \"ip_address\": {\n    \"id\": 2,\n    \"sane_source_ip\": \"10.10.10.10\",\n    \"blacklisted\": null,\n    \"ptr\": null,\n    \"country\": \"ro\",\n    \"created_at\": \"2020-01-16T09:37:38.309Z\",\n    \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"mta_sts_reports":{"doc_url":"/api/2.0/mta_sts_reports","id":"mta_sts_reports","api_url":"https://api.dmarcreport.com","name":"Mta sts reports","short_description":"          List, Search and Paginate the MTA STS Reports.\n          Plus get all the details of an individual Aggregat Report.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/mta_sts_reports/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports.json","http_method":"GET","short_description":"List, Search and Paginate MTA Reports","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"start_datetime_gteq","full_name":"q[start_datetime_gteq]","description":"\n\u003cp\u003eSearch by date begin start\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"start_datetime_lteq","full_name":"q[start_datetime_lteq]","description":"\n\u003cp\u003eSearch by date begin end\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"organization_name_eq","full_name":"q[organization_name_eq]","description":"\n\u003cp\u003eSearch by for orgnization name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"report_id_eq","full_name":"q[report_id_eq]","description":"\n\u003cp\u003eSearch by report id\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"policy_type_eq","full_name":"q[policy_type_eq]","description":"\n\u003cp\u003eSearch by policy type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"policy_host_eq","full_name":"q[policy_host_eq]","description":"\n\u003cp\u003eSearch by Policy host\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage Number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eEntries per page.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"reports\": [\n    {\n      \"id\": 1,\n      \"domain_id\": 1,\n      \"raw_json\": \"\",\n      \"organization_name\":  \"Google Inc.\", \n      \"start_datetime\":  \"2019-02-10T00:00:00.000Z\", \n      \"end_datetime\":  \"2019-02-10T23:59:59.000Z\", \n      \"contact_info\":  \"smtp-tls-reporting@google.com\", \n      \"report_id\":  \"2020-02-05T00:00:00Z_webheat.com\", \n      \"policy_type\":  \"sts\", \n      \"policy_string\":  '[\"version: STSv1\", \"mode: testing\", \"mx: mx1.eu.mailhop.org \", \"max_age: 386000\"]', \n      \"policy_domain\":  \"webheat.com\", \n      \"policy_host\":  \" \",\n      \"total_successful_session_count\":  \"10\",\n      \"total_failure_session_count\":  \"10\",\n      \"report_email_message_id\":  \"CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com\",\n    },\n    {\n      \"id\": 2,\n      \"domain_id\": 1,\n      \"raw_json\": \"\",\n      \"organization_name\":  \"Google Inc.\", \n      \"start_datetime\":  \"2019-02-10T00:00:00.000Z\", \n      \"end_datetime\":  \"2019-02-10T23:59:59.000Z\", \n      \"contact_info\":  \"smtp-tls-reporting@google.com\", \n      \"report_id\":  \"2020-02-05T00:00:00Z_webheat.com\", \n      \"policy_type\":  \"sts\", \n      \"policy_string\":  '[\"version: STSv1\", \"mode: testing\", \"mx: mx1.eu.mailhop.org \", \"max_age: 386000\"]', \n      \"policy_domain\":  \"webheat.com\", \n      \"policy_host\":  \" \",\n      \"total_successful_session_count\":  \"10\",\n      \"total_failure_session_count\":  \"10\",\n      \"report_email_message_id\":  \"CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com\",\n    },\n    {\n      \"id\": 3,\n      \"domain_id\": 1,\n      \"raw_json\": \"\",\n      \"organization_name\":  \"Google Inc.\", \n      \"start_datetime\":  \"2019-02-10T00:00:00.000Z\", \n      \"end_datetime\":  \"2019-02-10T23:59:59.000Z\", \n      \"contact_info\":  \"smtp-tls-reporting@google.com\", \n      \"report_id\":  \"2020-02-05T00:00:00Z_webheat.com\", \n      \"policy_type\":  \"sts\", \n      \"policy_string\":  '[\"version: STSv1\", \"mode: testing\", \"mx: mx1.eu.mailhop.org \", \"max_age: 386000\"]', \n      \"policy_domain\":  \"webheat.com\", \n      \"policy_host\":  \" \",\n      \"total_successful_session_count\":  \"10\",\n      \"total_failure_session_count\":  \"10\",\n      \"report_email_message_id\":  \"CAMxgm9Ehr85xOLJHtDe94GpLW03co1yo-GU=FfcZkeG0bzS+qw@mail.gmail.com\",\n    }\n  ],\n  \"meta\": {\n    \"total_reports\": 3,\n    \"current_page\": 1,\n    \"per_page\": 25,\n    \"total_pages\": 2\n  }\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/mta_sts_reports/mta_failure_details","name":"mta_failure_details","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/mta_failure_details.json","http_method":"GET","short_description":"List, Search and Paginate MTA Reports","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"q","full_name":"q","description":"\n\u003cp\u003eParams for Ransack Search\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"sending_mta_ip_address_source_ip_eq","full_name":"q[sending_mta_ip_address_source_ip_eq]","description":"\n\u003cp\u003eSearch by sending source ip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"receiving_ip_address_source_ip_eq","full_name":"q[receiving_ip_address_source_ip_eq]","description":"\n\u003cp\u003eSearch by receiving source ip\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"result_type_eq","full_name":"q[result_type_eq]","description":"\n\u003cp\u003eSearch byresult type\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"receiving_mx_hostname_eq","full_name":"q[receiving_mx_hostname_eq]","description":"\n\u003cp\u003eSearch by receiving mx host name\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}]},{"name":"page","full_name":"page","description":"\n\u003cp\u003ePage Number\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"per","full_name":"per","description":"\n\u003cp\u003eEntries per page.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n  \"failure-details\": [\n    { \"id\": 1,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.128.70\",\n      \"receiving_ip\": \"52.29.118.68\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 1,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    },\n    { \"id\": 2,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.221.70\",\n      \"receiving_ip\": \"52.29.118.68\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 1,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    },\n    { \"id\": 3,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.221.71\",\n      \"receiving_ip\": \"52.29.162.96\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 3,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    }\n  ]\n}\n"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/mta_sts_reports/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/domains/:domain_id/mta_sts_reports/:id.json","http_method":"GET","short_description":"Get all the details of a MTA Report","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n  \"id\": 1,\n  \"domain_id\": 1,\n  \"organization-name\": \"Google Inc.\",\n  \"start-datetime\": \"2020-02-05T00:00:00Z\",\n  \"end-datetime\": \"2020-02-05T23:59:59Z\",\n  \"contact-info\": \"smtp-tls-reporting@google.com\",\n  \"report-id\": \"2020-02-05T00:00:00Z_webheat.com\",\n  \"policy-type\": \"sts\",\n  \"policy-string\": [\n    \"version: STSv1\",\n    \"mode: testing\",\n    \"mx: mx1.eu.mailhop.org \",\n    \"max_age: 386000\"\n  ],\n  \"policy-domain\": \"webheat.com\",\n  \"total-successful-session-count\": 0,\n  \"total-failure-session-count\": 7,\n  \"failure-details\": [\n    { \"id\": 1,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.128.70\",\n      \"receiving_ip\": \"52.29.118.68\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 1,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    },\n    { \"id\": 2,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.221.70\",\n      \"receiving_ip\": \"52.29.118.68\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 1,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    },\n    { \"id\": 3,\n      \"result_type\": \"certificate-host-mismatch\",\n      \"sending_mta_ip\": \"209.85.221.71\",\n      \"receiving_ip\": \"52.29.162.96\",\n      \"receiving_mx_hostname\": \"mx1.eu.mailhop.org\",\n      \"failed_session_count\": 3,\n      \"ip_address\": {\n        \"id\": 2,\n        \"sane_source_ip\": \"10.10.10.10\",\n        \"blacklisted\": null,\n        \"ptr\": null,\n        \"country\": \"ro\",\n        \"created_at\": \"2020-01-16T09:37:38.309Z\",\n        \"updated_at\": \"2020-01-16T09:37:38.323Z\"\n      }\n    }\n  ]\n}\n\n"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"postmaster_account_records":{"doc_url":"/api/2.0/postmaster_account_records","id":"postmaster_account_records","api_url":"https://api.dmarcreport.com","name":"Postmaster account records","short_description":"          List and Search the Postmaster accounts.\n          Plus get all the details of an individual Postmaster Account domain.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/postmaster_account_records/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/postmaster_account_records.json","http_method":"GET","short_description":"Cumulative data of all domains of a Postmaster Account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of Postmaster Account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n    \"data\": {\n        \"abc.com\": {\n            \"total_spam_ratio\": 0.0,\n            \"domain_reputation\": \"HIGH\",\n            \"total_spf_success\": 43.0,\n            \"total_dkim_success\": 43.0,\n            \"total_dmarc_success\": 35.703,\n            \"total_inbound_encryption\": 43.0,\n            \"total_records\": 43,\n            \"delivery_errors\": 0.0,\n            \"ip_reputations\": {\n                \"counts\": {},\n                \"percentages\": {}\n            },\n            \"average_spam_ratio\": 0.0,\n            \"average_spf_success\": 100.0,\n            \"average_dkim_success\": 100.0,\n            \"average_dmarc_success\": 83.0,\n            \"average_inbound_encryption\": 100.0\n        },\n        \"xyz.com\": {\n            \"error_message\": \"The caller does not have permission\"\n        },\n        \"example.org\": {\n            \"total_spam_ratio\": 0.20600000000000002,\n            \"domain_reputation\": \"HIGH\",\n            \"total_spf_success\": 79.0,\n            \"total_dkim_success\": 79.0,\n            \"total_dmarc_success\": 1.338,\n            \"total_inbound_encryption\": 79.0,\n            \"total_records\": 79,\n            \"delivery_errors\": 0.0,\n            \"ip_reputations\": {\n                \"counts\": {\n                    \"BAD\": 363,\n                    \"LOW\": 448,\n                    \"MEDIUM\": 1747,\n                    \"HIGH\": 2387\n                },\n                \"percentages\": {\n                    \"BAD\": 7.3,\n                    \"LOW\": 9.1,\n                    \"MEDIUM\": 35.3,\n                    \"HIGH\": 48.3\n                }\n            },\n            \"average_spam_ratio\": 0.3,\n            \"average_spf_success\": 100.0,\n            \"average_dkim_success\": 100.0,\n            \"average_dmarc_success\": 1.7,\n            \"average_inbound_encryption\": 100.0\n        }\n    }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/postmaster_account_records/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/postmaster_account_records/:id.json","http_method":"GET","short_description":"Details of a Postmaster Account domain.","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"email","full_name":"email","description":"\n\u003cp\u003eEmail address of Postmaster Account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"item","full_name":"item","description":"\n\u003cp\u003eDomain for which data is needed\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]}],"returns":[],"examples":["{\n    \"spam_rate_data\": {\n        \"2025-02-20\": 0.0,\n        \"2025-02-24\": 0.0,\n        \"2025-05-05\": 0.0,\n        \"2025-05-06\": 0.0,\n        \"2025-05-15\": 0.0\n    },\n    \"ip_reputation_data\": {\n        \"2025-02-20\": {\n            \"BAD\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"LOW\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"MEDIUM\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"HIGH\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            }\n        },\n        \"2025-02-21\": {\n            \"BAD\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"LOW\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"MEDIUM\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"HIGH\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            }\n        },\n        \"2025-05-15\": {\n            \"BAD\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"LOW\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"MEDIUM\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            },\n            \"HIGH\": {\n                \"percentage\": 0.0,\n                \"ips\": []\n            }\n        }\n    },\n    \"domain_reputation_data\": {\n        \"2025-02-20\": \"High\",\n        \"2025-03-21\": \"High\",\n        \"2025-03-26\": \"High\",\n        \"2025-03-27\": \"High\",\n        \"2025-03-31\": \"High\",\n        \"2025-04-01\": \"High\",\n        \"2025-05-12\": \"High\",\n        \"2025-05-14\": \"High\",\n        \"2025-05-15\": \"High\"\n    },\n    \"feedback_loop_data\": {\n        \"2025-05-09\": [\n            {\n                \"id\": 41,\n                \"domain\": \"xyz.com\",\n                \"date\": \"2025-05-09\",\n                \"spam_rate\": 0.0,\n                \"spammy_feedback_loops\": 0\n            }\n        ],\n        \"2025-05-12\": [\n            {\n                \"id\": 42,\n                \"domain\": \"xyz.com\",\n                \"date\": \"2025-05-12\",\n                \"spam_rate\": 0.0,\n                \"spammy_feedback_loops\": 0\n            }\n        ],\n        \"2025-05-14\": [\n            {\n                \"id\": 43,\n                \"domain\": \"xyz.com\",\n                \"date\": \"2025-05-14\",\n                \"spam_rate\": 0.0,\n                \"spammy_feedback_loops\": 0\n            }\n        ],\n        \"2025-05-15\": [\n            {\n                \"id\": 44,\n                \"domain\": \"xyz.com\",\n                \"date\": \"2025-05-15\",\n                \"spam_rate\": 0.0,\n                \"spammy_feedback_loops\": 0\n            }\n        ]\n    },\n    \"authentication_data\": {\n        \"2025-05-12\": {\n            \"spf\": 100.0,\n            \"dkim\": 100.0,\n            \"dmarc\": 100.0\n        },\n        \"2025-05-14\": {\n            \"spf\": 100.0,\n            \"dkim\": 100.0,\n            \"dmarc\": 98.1\n        },\n        \"2025-05-15\": {\n            \"spf\": 100.0,\n            \"dkim\": 100.0,\n            \"dmarc\": 99.1\n        }\n    },\n    \"encryption_data\": {\n        \"2025-05-08\": {\n            \"inbound_tls\": 100.0,\n            \"outbound_tls\": \"N/A\"\n        },\n        \"2025-05-09\": {\n            \"inbound_tls\": 100.0,\n            \"outbound_tls\": \"N/A\"\n        },\n        \"2025-05-12\": {\n            \"inbound_tls\": 100.0,\n            \"outbound_tls\": \"N/A\"\n        },\n        \"2025-05-14\": {\n            \"inbound_tls\": 100.0,\n            \"outbound_tls\": \"N/A\"\n        },\n        \"2025-05-15\": {\n            \"inbound_tls\": 100.0,\n            \"outbound_tls\": \"N/A\"\n        }\n    },\n    \"delivery_errors_data\": {\n        \"2025-02-20\": [],\n        \"2025-03-26\": [\n            {\n                \"error_type\": \"PERMANENT_ERROR\",\n                \"reason\": \"Content Spammy\",\n                \"percentage\": 0.7\n            }\n        ],\n        \"2025-03-27\": [],\n        \"2025-05-14\": [],\n        \"2025-05-15\": []\n    }\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/postmaster_account_records/connected","name":"connected","apis":[{"api_url":"https://api.dmarcreport.com/v2/postmaster_account_records/connected.json","http_method":"GET","short_description":"List of connected Postmaster Accounts.","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"connected_accounts\": [\n        {\n            \"id\": 3,\n            \"email\": \"abc@gmail.com\",\n            \"created_at\": \"2025-05-16T09:26:58.159Z\"\n        },\n        {\n            \"id\": 4,\n            \"email\": \"xyz@example.com\",\n            \"created_at\": \"2025-05-20T10:47:52.964Z\"\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false},"user_accounts":{"doc_url":"/api/2.0/user_accounts","id":"user_accounts","api_url":"https://api.dmarcreport.com","name":"Account members","short_description":"\t\t      List of all members in your account.\n          Plus you can add, remove and veiw details of members in your account.\n","full_description":"","version":"2.0","formats":["JSON"],"metadata":null,"methods":[{"doc_url":"/api/2.0/user_accounts/index","name":"index","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/user_accounts","http_method":"GET","short_description":"List user accounts","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"account_owner_email\": \"abc@xyz.org\",\n    \"user_accounts\": [\n        {\n            \"id\": 6,\n            \"account_id\": 1484,\n            \"user_id\": 713,\n            \"domains\": true,\n            \"alerts\": true,\n            \"domains_reports\": false,\n            \"plans\": false,\n            \"profile\": false,\n            \"reports\": true,\n            \"summary\": true,\n            \"teams\": true,\n            \"timeline\": true,\n            \"widgets\": true,\n            \"subscription\": true,\n            \"create_teams\": true\n        },\n        {\n            \"id\": 7,\n            \"account_id\": 1484,\n            \"user_id\": 1737,\n            \"domains\": true,\n            \"alerts\": true,\n            \"domains_reports\": false,\n            \"plans\": false,\n            \"profile\": false,\n            \"reports\": true,\n            \"summary\": true,\n            \"teams\": true,\n            \"timeline\": true,\n            \"widgets\": true,\n            \"subscription\": true,\n            \"create_teams\": false\n        },\n        {\n            \"id\": 8,\n            \"account_id\": 1484,\n            \"user_id\": 49,\n            \"domains\": true,\n            \"alerts\": true,\n            \"domains_reports\": false,\n            \"plans\": false,\n            \"profile\": false,\n            \"reports\": true,\n            \"summary\": true,\n            \"teams\": true,\n            \"timeline\": true,\n            \"widgets\": true,\n            \"subscription\": false,\n            \"create_teams\": true\n        }\n    ]\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/user_accounts/show","name":"show","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id","http_method":"GET","short_description":"Details of user account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":["{\n    \"id\": 8,\n    \"user_id\": 49,\n    \"account_id\": 13,\n    \"profile\": false,\n    \"domains_reports\": false,\n    \"plans\": false,\n    \"api_tokens\": false,\n    \"domains\": true,\n    \"summary\": true,\n    \"timeline\": true,\n    \"reports\": true,\n    \"alerts\": true,\n    \"teams\": true,\n    \"widgets\": true,\n    \"timestamp\": null,\n    \"sso\": false,\n    \"tag\": false,\n    \"subscription\": false,\n    \"create_teams\": true\n}"],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/user_accounts/create","name":"create","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/user_accounts.json","http_method":"POST","short_description":"Add user in account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"user_account","full_name":"user_account","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"email","full_name":"user_account[email]","description":"\n\u003cp\u003eemail of user, you want to add in account\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domains_reports","full_name":"user_account[domains_reports]","description":"\n\u003cp\u003edomains_reports access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"alerts","full_name":"user_account[alerts]","description":"\n\u003cp\u003ealerts access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domains","full_name":"user_account[domains]","description":"\n\u003cp\u003edomains access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reports","full_name":"user_account[reports]","description":"\n\u003cp\u003ereports access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"summary","full_name":"user_account[summary]","description":"\n\u003cp\u003esummary access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"teams","full_name":"user_account[teams]","description":"\n\u003cp\u003eteams access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timeline","full_name":"user_account[timeline]","description":"\n\u003cp\u003etimeline access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"widgets","full_name":"user_account[widgets]","description":"\n\u003cp\u003ewidgets access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sso","full_name":"user_account[sso]","description":"\n\u003cp\u003esso access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"user_account[tag]","description":"\n\u003cp\u003etag access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"user_account[subscription]","description":"\n\u003cp\u003esubscription access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"create_teams","full_name":"user_account[create_teams]","description":"\n\u003cp\u003ecreate_teams access flag\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/user_accounts/update","name":"update","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json","http_method":"PUT","short_description":"Update user in account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[{"name":"user_account","full_name":"user_account","description":"","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a Hash","expected_type":"hash","metadata":null,"show":true,"validations":[],"params":[{"name":"domains_reports","full_name":"user_account[domains_reports]","description":"\n\u003cp\u003edomains_reports access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"alerts","full_name":"user_account[alerts]","description":"\n\u003cp\u003ealerts access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"domains","full_name":"user_account[domains]","description":"\n\u003cp\u003edomains access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"reports","full_name":"user_account[reports]","description":"\n\u003cp\u003ereports access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"summary","full_name":"user_account[summary]","description":"\n\u003cp\u003esummary access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"teams","full_name":"user_account[teams]","description":"\n\u003cp\u003eteams access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"timeline","full_name":"user_account[timeline]","description":"\n\u003cp\u003etimeline access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"widgets","full_name":"user_account[widgets]","description":"\n\u003cp\u003ewidgets access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"sso","full_name":"user_account[sso]","description":"\n\u003cp\u003esso access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"tag","full_name":"user_account[tag]","description":"\n\u003cp\u003etag access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"subscription","full_name":"user_account[subscription]","description":"\n\u003cp\u003esubscription access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]},{"name":"create_teams","full_name":"user_account[create_teams]","description":"\n\u003cp\u003ecreate_teams access flag\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[]}]}],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/api/2.0/user_accounts/destroy","name":"destroy","apis":[{"api_url":"https://api.dmarcreport.com/v2/accounts/:account_id/user_accounts/:id.json","http_method":"DELETE","short_description":"Delete user from account","deprecated":null}],"formats":["JSON"],"full_description":"","errors":[{"code":401,"description":"Unauthorized","metadata":null},{"code":403,"description":"Forbidden","metadata":null},{"code":404,"description":"Not Found","metadata":null},{"code":500,"description":"Server crashed for some reason","metadata":null}],"params":[],"returns":[],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":[],"deprecated":false}}}}