Benchmark Email Reports API
Campaign reporting and analytics
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/benchmark-email-reports-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: Benchmark Email Reports API
version: '1.0'
description: 'Operations tagged reports across 2 of this provider''s published API definitions: benchmark-email-api-openapi.json, benchmark-email-reports-api-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: Your account's API base URL. Copy the full URL shown on Settings > API Keys in your Benchmark Email account and paste it here.
url: '{apiBaseUrl}'
variables:
apiBaseUrl:
default: ''
description: Your account's API base URL. Copy it from Settings > API Keys in your Benchmark Email account.
- url: https://clientapi.benchmarkemail.com
description: Benchmark Email Client API
security:
- apiKeyAuth: []
tags:
- description: Report related endpoints
name: reports
paths:
/api/reports/dashboard:
get:
operationId: get_api_reports_dashboard
parameters:
- description: The number of past days (between 1 and 90) to retrieve report stats and precedent stats.
in: query
name: pastDays
required: true
schema:
maximum: 90
minimum: 1
type: integer
- description: The user timezone (IANA) code.
in: query
name: timezone
required: false
schema:
default: UTC
example: America/La_Paz
type: string
responses:
'200':
content:
application/json:
schema:
properties:
campaign:
description: campaign reports
properties:
delivered:
description: delivered emails statistics.
properties:
count:
description: delivered email count.
example: 2203
type: integer
diff:
description: delivered email difference from previous period.
example: 11.3
format: float
type: number
type: object
sent:
description: sent emails statistics.
properties:
count:
description: sent email count.
example: 2379
type: integer
diff:
description: sent email difference from previous period.
example: 0.76
format: float
type: number
type: object
uniqueClicks:
description: clicked emails statistics.
properties:
count:
properties:
diff:
description: unique clicked email count difference from previous period.
example: -21.52
format: float
type: number
value:
description: unique clicked email count
example: 569
type: integer
type: object
rate:
properties:
diff:
description: unique clicked email rate difference from previous period.
example: 20.47
format: float
type: number
value:
description: unique clicked email rate (opens/delivered)
example: 25.83
format: float
type: number
type: object
type: object
uniqueOpens:
description: unique opened emails statistics.
properties:
count:
properties:
diff:
description: unique opened email count difference from previous period.
example: -23.41
format: float
type: number
value:
description: unique opened email count
example: 733
type: integer
type: object
rate:
properties:
diff:
description: unique opened email rate difference from previous period.
example: -22.41
format: float
type: number
value:
description: unique opened email rate (opens/delivered)
example: 33.27
format: float
type: number
type: object
type: object
type: object
contact:
properties:
count:
properties:
diff:
description: contact count diff from past time period
example: 29.55
format: float
type: number
value:
description: current contact count
example: 5900
type: number
type: object
histogram:
properties:
end:
description: contact snapshot histogram end date point
example: '2024-10-29T00:00:00.000Z'
format: date-time
type: string
histogram:
items:
properties:
date:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
total:
example: 4
type: integer
type: object
type: array
peak:
properties:
date:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
total:
example: 4
type: integer
type: object
start:
description: contact snapshot histogram start date point
example: '2024-09-29T00:00:00.000Z'
format: date-time
type: string
type: object
type: object
type: object
description: Successfully report retrieved
security:
- apiKeyAuth: []
summary: Get dashboard snapshot reports
tags:
- reports
x-api-key-scope: reports:read
servers:
- description: Your account's API base URL. Copy the full URL shown on Settings > API Keys in your Benchmark Email account and paste it here.
url: '{apiBaseUrl}'
variables:
apiBaseUrl:
default: ''
description: Your account's API base URL. Copy it from Settings > API Keys in your Benchmark Email account.
/api/reports/email/overall:
get:
operationId: get_api_reports_email_overall
parameters:
- description: The number of past days (between 1 and 90) to retrieve report stats and precedent stats.
in: query
name: pastDays
required: true
schema:
maximum: 90
minimum: 1
type: integer
- description: The user timezone (IANA) code.
in: query
name: timezone
required: false
schema:
default: UTC
example: America/La_Paz
type: string
responses:
'200':
content:
application/json:
schema:
properties:
campaignComparison:
items:
properties:
_id:
description: Campaign ID
type: string
name:
description: Campaign name
type: string
rates:
properties:
clicks:
description: Click rate
format: float
type: number
opens:
description: Open rate
format: float
type: number
type: object
scheduledAt:
description: Campaign scheduled at
format: date-time
type: string
type: object
type: array
deliveryTimeStats:
description: Email delivery open rates by day time distribution statistics.
properties:
afternoon:
description: Percentage of open rate for delivered in the afternoon. (10am-4pm)
example: 39.18
format: float
type: number
evening:
description: Percentage of open rate for delivered in the evening. (4pm-10pm)
example: 0
format: float
type: number
morning:
description: Percentage of open rate for delivered in the morning. (4am-10am)
example: 34.28
format: float
type: number
night:
description: Percentage of open rate for delivered at night. (10pm-4am)
example: 0
format: float
type: number
type: object
stats:
properties:
complaints:
description: Complaint emails statistics.
properties:
count:
properties:
diff:
description: Complaint count difference from previous period.
example: 100
format: float
type: number
prev:
description: Previous period complaint email count.
example: 5
type: integer
value:
description: Complaint count.
example: 10
type: integer
type: object
type: object
delivered:
description: Delivered emails statistics.
properties:
count:
properties:
diff:
description: Delivered email count difference from previous period.
example: -42.95
format: float
type: number
prev:
description: Previous period delivered email count.
example: 3722
type: integer
value:
description: Delivered email count.
example: 2611
type: integer
type: object
type: object
hardBounces:
description: Hard bounce emails statistics.
properties:
count:
properties:
diff:
description: Hard bounce email count difference from previous period.
example: -25.64
format: float
type: number
prev:
description: Previous period hard bounce email count.
example: 152
type: integer
value:
description: Hard bounce email count.
example: 116
type: integer
type: object
rate:
properties:
diff:
description: Hard bounce email rate difference from previous period.
example: 30.21
format: float
type: number
prev:
description: Previous period hard bounce email rate (bounces/sent).
example: 22.32
format: float
type: number
value:
description: Hard bounce email rate (bounces/sent).
example: 28.53
format: float
type: number
type: object
type: object
sent:
description: Sent emails statistics.
properties:
count:
properties:
diff:
description: Sent email count difference from previous period.
example: -42.28
format: float
type: number
prev:
description: Previous period sent email count.
example: 3942
type: integer
value:
description: Sent email count.
example: 2822
type: integer
type: object
type: object
softBounces:
description: Soft bounce emails statistics.
properties:
count:
properties:
diff:
description: Soft bounce email count difference from previous period.
example: -39.1
format: float
type: number
prev:
description: Previous period soft bounce email count.
example: 125
type: integer
value:
description: Soft bounce email count.
example: 95
type: integer
type: object
rate:
properties:
diff:
description: Soft bounce email rate difference from previous period.
example: 30.21
format: float
type: number
prev:
description: Previous period soft bounce email rate (bounces/sent).
example: 22.32
format: float
type: number
value:
description: Soft bounce email rate (bounces/sent).
example: 28.53
format: float
type: number
type: object
type: object
totalBounces:
description: Total bounce emails statistics.
properties:
count:
properties:
diff:
description: Total bounce email count difference from previous period.
example: -25.64
format: float
type: number
prev:
description: Previous period total bounce email count.
example: 152
type: integer
value:
description: Total bounce email count.
example: 116
type: integer
type: object
rate:
properties:
diff:
description: Total bounce email rate difference from previous period.
example: 30.21
format: float
type: number
prev:
description: Previous period total bounce email rate (bounces/sent).
example: 22.32
format: float
type: number
value:
description: Total bounce email rate (bounces/sent).
example: 28.53
format: float
type: number
type: object
type: object
uniqueClicks:
description: Unique clicked emails statistics.
properties:
count:
properties:
diff:
description: Unique clicked email count difference from previous period.
example: -25.72
format: float
type: number
prev:
description: Previous period unique clicked email count.
example: 1283
type: integer
value:
description: Unique clicked email count.
example: 745
type: integer
type: object
rate:
properties:
diff:
description: Unique clicked email rate difference from previous period.
example: 30.21
format: float
type: number
prev:
description: Previous period unique clicked email rate (clicks/delivered).
example: 22.32
format: float
type: number
value:
description: Unique clicked email rate (clicks/delivered).
example: 28.53
format: float
type: number
type: object
type: object
uniqueOpens:
description: Unique opened emails statistics.
properties:
count:
properties:
diff:
description: Unique opened email count difference from previous period.
example: -28.34
format: float
type: number
prev:
description: Previous period unique opened email count.
example: 1283
type: integer
value:
description: Unique opened email count.
example: 971
type: integer
type: object
rate:
properties:
diff:
description: Unique opened email rate difference from previous period.
example: 25.64
format: float
type: number
prev:
description: Previous period unique opened email rate (opens/delivered).
example: 27.32
format: float
type: number
value:
description: Unique opened email rate (opens/delivered).
example: 37.19
format: float
type: number
type: object
type: object
unsubscribes:
description: Unsubscribed emails statistics.
properties:
count:
properties:
diff:
description: Unsubscribe count difference from previous period.
example: -25
format: float
type: number
prev:
description: Previous period unsubscribed email count.
example: 125
type: integer
value:
description: Unsubscribe count.
example: 100
type: integer
type: object
type: object
type: object
type: object
description: Successfully report retrieved
security:
- apiKeyAuth: []
summary: Get overall email reports
tags:
- reports
x-api-key-scope: reports:read
servers:
- description: Your account's API base URL. Copy the full URL shown on Settings > API Keys in your Benchmark Email account and paste it here.
url: '{apiBaseUrl}'
variables:
apiBaseUrl:
default: ''
description: Your account's API base URL. Copy it from Settings > API Keys in your Benchmark Email account.
/api/reports/email/overall/histogram:
get:
operationId: get_api_reports_email_overall_histogram
parameters:
- description: The number of past days (between 1 and 90) to retrieve the event type histogram.
in: query
name: pastDays
required: true
schema:
maximum: 90
minimum: 1
type: integer
- description: The requested campaign event type to generate the histogram.
in: query
name: eventType
required: true
schema:
enum:
- email-sent
- email-delivered
- email-bounced
- first-contact-unsubscribed
- first-email-complaint
- first-email-opened
- first-email-clicked
type: string
- description: The user timezone (IANA) code.
in: query
name: timezone
required: false
schema:
default: UTC
example: America/La_Paz
type: string
responses:
'200':
content:
application/json:
schema:
description: Campaign histogram details
properties:
end:
example: '2024-09-24T17:00:00.000Z'
format: date-time
type: string
histogram:
items:
properties:
date:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
detail:
description: Details only for email-bounced event type
properties:
hard:
example: 3
type: integer
soft:
example: 1
type: integer
type: object
total:
example: 4
type: integer
type: object
type: array
peak:
properties:
endDate:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
startDate:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
total:
example: 4
type: integer
type: object
start:
example: '2024-09-23T17:00:00.000Z'
format: date-time
type: string
type: object
description: Successfully report retrieved
security:
- apiKeyAuth: []
summary: Get overall email histogram by event type
tags:
- reports
x-api-key-scope: reports:read
servers:
- description: Your account's API base URL. Copy the full URL shown on Settings > API Keys in your Benchmark Email account and paste it here.
url: '{apiBaseUrl}'
variables:
apiBaseUrl:
default: ''
description: Your account's API base URL. Copy it from Settings > API Keys in your Benchmark Email account.
/api/reports/email/{id}:
get:
operationId: get_api_reports_email_by_id
parameters:
- description: email campaign identifier
in: path
name: id
required: true
schema:
type: string
responses:
'200':
content:
application/json:
schema:
properties:
linkActivity:
description: List of link activity
items:
properties:
clicks:
properties:
total:
example: 0
type: integer
unique:
example: 0
type: integer
type: object
id:
example: 66f1a6e4698f1bca60424808
type: string
path:
example: https://instagram.com/
type: string
type: object
type: array
stats:
description: Statistics of the campaign
properties:
clicks:
description: Email clicks statistics
properties:
last:
example: '2024-09-27T18:28:40.575Z'
format: date-time
type: string
rate:
example: 25.8
format: float
type: number
unique:
example: 169
type: integer
type: object
complaints:
description: Number of complaints
example: 0
type: integer
delivered:
description: Total number of delivered emails
example: 655
type: integer
hardBounces:
description: Hard bounce emails statistics
properties:
count:
example: 25
type: integer
rate:
example: 3.81
format: float
type: number
type: object
opens:
description: Email opens statistics
properties:
last:
example: '2024-09-27T17:33:45.464Z'
format: date-time
type: string
rate:
example: 32.06
format: float
type: number
unique:
example: 210
type: integer
type: object
sent:
description: Total number of sent emails
example: 697
type: integer
softBounces:
description: Soft bounce emails statistics
properties:
count:
example: 17
type: in
# --- truncated at 32 KB (87 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/benchmark-email/refs/heads/main/openapi/benchmark-email-reports-api-openapi.yml