ReachScore Docs
API Reference

Reports

Generate aggregate reports, view deliverability trends over time, and share results with stakeholders via public links.

Analytics

Aggregate summary of test results over a time period. Includes total tests, average scores, and top issues.

Query Parameters

periodstringdefault: week

Time period for aggregation

dayweekmonth
domain_idstring

Filter by domain ID

Response

periodstring
total_testsinteger
avg_scorenumber
inbox_ratenumber
top_issuesarray

Most common issues found

Example Request

curl "https://api.reachscore.co/v1/reports/summary?period=week" \
  -H "Authorization: Bearer rk_live_xxx"

Example Response

{
  "period": "week",
  "total_tests": 47,
  "avg_score": 88.5,
  "inbox_rate": 0.92,
  "top_issues": [
    { "issue": "Missing DMARC record", "count": 3 },
    { "issue": "SPF include limit exceeded", "count": 2 }
  ]
}

Shared Reports

Create shareable report links to share results with stakeholders who don't have API access.

Generate a shareable report URL. The link provides read-only access to test results.

Request Bodyrequired

test_idsarrayrequired

Test IDs to include in the report

expires_ininteger

Expiration time in seconds (default: 7 days)

Response

idstring

Shared report ID (rpt_xxx)

objectstring

Always 'shared_report'

urlstring<uri>

Public URL to view the report

tokenstring

Access token in the URL

expires_atstring<date-time>
created_atstring<date-time>

Example Request

curl -X POST https://api.reachscore.co/v1/reports/share \
  -H "Authorization: Bearer rk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "test_ids": ["test_7xK2mN9pQrT4v", "test_8yL3nO0qRsU5w"],
    "expires_in": 604800
  }'

Example Response

{
  "id": "rpt_7cM2pQ6rTvW8",
  "object": "shared_report",
  "url": "https://app.reachscore.co/reports/public/abc123xyz",
  "token": "abc123xyz",
  "expires_at": "2026-03-18T10:30:00Z",
  "created_at": "2026-03-11T10:30:00Z"
}

Scheduled Reports

Set up automated report deliveries to receive regular summaries via email.

Create a scheduled report delivery. Reports will be sent to specified recipients on a regular schedule.

Request Bodyrequired

namestringrequired

Name for this schedule

frequencystringrequired
dailyweeklymonthly
recipientsarrayrequired

Email addresses to send reports to

domainsarray

Domain IDs to include (null means all)

include_sectionsarray

Sections to include in the report

summarytrendsalerts
formatstring
htmlpdf

Example Request

curl -X POST https://api.reachscore.co/v1/reports/schedules \
  -H "Authorization: Bearer rk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Weekly Deliverability Report",
    "frequency": "weekly",
    "recipients": ["team@yourcompany.com"],
    "include_sections": ["summary", "trends"],
    "format": "html"
  }'

Example Response

{
  "id": "rps_8dN3qR7sUwX9",
  "object": "report_schedule",
  "name": "Weekly Deliverability Report",
  "frequency": "weekly",
  "recipients": ["team@yourcompany.com"],
  "domains": null,
  "include_sections": ["summary", "trends"],
  "format": "html",
  "enabled": true,
  "next_send_at": "2026-03-17T09:00:00Z",
  "created_at": "2026-03-11T10:30:00Z"
}
Previous: AlertsNext: Team