This schema describes objects returned by the Inbox Placement Blacklist & SpamAssassin Report endpoints.
Fields
| Field | Type | Required | Description |
|---|---|---|---|
id | string (uuid) | Yes | Unique identifier for the inbox placement report entry (read-only) |
timestamp_created | string | Yes | Timestamp when the inbox placement report was created (read-only) |
timestamp_created_date | string | Yes | Date when the inbox placement report was created (read-only) |
organization_id | string (uuid) | Yes | Organization ID (read-only) |
test_id | string (uuid) | Yes | Inbox Placement Test ID (read-only) |
domain_blacklist_count | number, nullable | No | Count of blacklists the domain is listed on (read-only) |
domain | string | Yes | Domain of the inbox placement report (read-only) |
domain_ip | string | Yes | IP address of the domain (read-only) |
domain_ip_blacklist_count | number, nullable | No | Count of blacklists the domain IP is listed on (read-only) |
spam_assassin_score | number | Yes | SpamAssassin score for the email, indicating spam likelihood (read-only) |
spam_assassin_report | object | No | Detailed SpamAssassin analysis report (read-only) |
spam_assassin_report.is_spam | boolean | No | Indicates if the message is classified as spam by SpamAssassin |
spam_assassin_report.report | array | No | List of individual SpamAssassin rule evaluations |
spam_assassin_report.report[].description | string | No | The section or type of the rule triggered |
spam_assassin_report.report[].name | string | No | The name of the SpamAssassin rule |
spam_assassin_report.report[].score | string | No | The score assigned to this rule evaluation |
spam_assassin_report.spam_score | integer | No | Overall spam score assigned to the message by SpamAssassin |
blacklist_report | object | No | Detailed blacklist report for the domain or IP (read-only) |
blacklist_report.address | string | No | The address or domain associated with the report |
blacklist_report.blacklisted_count | integer | No | The count of blacklists the address is listed on |
blacklist_report.details | array | No | List of individual blacklist details |
blacklist_report.details[].blacklist | string | No | The name of the blacklist |
blacklist_report.details[].is_listed | boolean | No | Whether the address is listed on this blacklist |
blacklist_report.details[].test_type | string | No | The type of test |
blacklist_report.ip | string | No | The IP address associated with the blacklist check |
blacklist_report.is_blacklisted | boolean | No | Overall status indicating if the address is blacklisted |
blacklist_report.is_domain | boolean | No | Whether the address is a domain |