How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Benchmark Email Reports API

Campaign reporting and analytics

Benchmark Email Reports API is one of 30 APIs that Benchmark Email publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a GitHub repository.

This API exposes 41 operations across 40 paths. It is described by OpenAPI 3.0.3, at version 3.0.0.

Requests are made against a single base URL, https://clientapi.benchmarkemail.com.

41 operations 40 paths 0 schemas 39 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
3.0.0
Base URL
https://clientapi.benchmarkemail.com
Authentication
API Key
License
Proprietary
Resource Areas
1

Authentication & Security 1

Benchmark Email Reports API declares 1 security scheme for authenticating requests. An API key is passed in the header as AuthToken (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API token obtained from https://ui.benchmarkemail.com/IntegrateAPI

Paths & Operations 41

Across 40 paths, the API surfaces 41 operations — 39 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Reports 41

Campaign reporting and analytics

POST
/Emails/{ID}/{RType}/Report/Download
Report Download
post__emails__id___rtype__report_download 2 params → 200400401404
GET
/Emails/{ID}/{RType}/Report/Download
Get Report Download
get__emails__id___rtype__report_download 2 params → 200400401404
GET
/Emails/{ID}/Report/Unsubscribes
GET Unsubscribe report By Email ID
get__emails__id__report_unsubscribes 1 param → 200400401404
PATCH
/Emails/SaveAsList
Save as List
patch__emails_saveaslist → 200400401404
GET
/Emails/GetSaveAsList
GET Save as List
get__emails_getsaveaslist → 200400401404
GET
/Emails/{ID}/Report
GET Report Details By Email ID
get__emails__id__report 1 param → 200400401404
GET
/Emails/{ID}/Report/Forwards
GET Forwards report By Email ID
get__emails__id__report_forwards 1 param → 200400401404
GET
/Emails/{ID}/Report/Unopens
GET Unopens report By Email ID
get__emails__id__report_unopens 1 param → 200400401404
GET
/Emails/{ID}/Report/Clicks
GET Clicks report By Email ID
get__emails__id__report_clicks 1 param → 200400401404
GET
/Emails/{ID}/Report/Bounces
GET Bounces report By Email ID
get__emails__id__report_bounces 1 param → 200400401404
GET
/Emails/{ID}/Report/AbuseCampaign
GET AbuseCampaign report By Email ID
get__emails__id__report_abusecampaign 1 param → 200400401404
GET
/Emails/Report/Abuse
GET Abuse report
get__emails_report_abuse → 200400401404
GET
/Emails/{ID}/Report/SocialPerformance
GET Social Performance
get__emails__id__report_socialperformance 1 param → 200400401404
GET
/Emails/{ID}/Report/Opens
GET Opens Report
get__emails__id__report_opens 1 param → 200400401404
GET
/Emails/{ID}/Report/Opens/Location
GET Opens Location Report
get__emails__id__report_opens_location 1 param → 200400401404
GET
/Emails/{ID}/Report/Opens/Location/{CountryCode}
GET Opens Location Report By Email ID and CountryCode
get__emails__id__report_opens_location__countrycode 2 params → 200400401404
GET
/Emails/{ID}/Report/Opens/Hourly
GET Opens Hourly Report By Email ID
get__emails__id__report_opens_hourly 1 param → 200400401404
GET
/Emails/{ID}/Report/ClickPerformance
GET Click Performance By Email ID
get__emails__id__report_clickperformance 1 param → 200400401404
GET
/Emails/{ID}/Report/Click/HeatMap
GET Click HeatMap By Email ID
get__emails__id__report_click_heatmap 1 param → 200400401404
GET
/Emails/{ID}/Report/ClickPerformance/Details
GET Click Performance Details By Email ID
get__emails__id__report_clickperformance_details 1 param → 200400401404
GET
/Emails/{ID}/CampaignHistory
GET Campaign History By Email ID
get__emails__id__campaignhistory 1 param → 200400401404
GET
/Emails/{ID}/LinkDetail
GET Link Detail By Email ID
get__emails__id__linkdetail 1 param → 200400401404
GET
/Emails/{ID}/RSSHistory
GET RSS History By Email ID
get__emails__id__rsshistory 1 param → 200400401404
GET
/Emails/{ID}/URLList
GET URL List By Email ID
get__emails__id__urllist 1 param → 200400401404
GET
/Emails/{ID}/Report/Opens/{Country}/{Region}
Getting opens by country and region
get__emails__id__report_opens__country___region 3 params → 200400401404
GET
/Emails/Report
Get Report
get__emails_report → 200400401404
GET
/Automation/Report
Get Reports for Autoresponders
get__automation_report → 200400401404
GET
/Automation/{AutomationID}/Report
Get Summary Report of an Automation
get__automation__automationid__report 1 param → 200400401404
GET
/ABSplit/{ID}/Results
Get the Results for the AB Test
get__absplit__id__results 1 param → 200400401404
GET
/ABSplit/Report
GET AB Test Report
get__absplit_report → 200400401404
GET
/ABSplit/{ID}/{ABID}/Report
GET Report Details By AB Test ID
get__absplit__id___abid__report 2 params → 200400401404
GET
/ABSplit/{ID}/Compare
GET Compare report By AB Test ID
get__absplit__id__compare 1 param → 200400401404
GET
/Survey/ReportList
Get Report List of Survey
get__survey_reportlist 5 params → 200400401404
GET
/Survey/{SurveyID}/ReportDetail
Get Report detail of Survey
get__survey__surveyid__reportdetail 1 param → 200400401404
GET
/Survey/{SurveyID}/ReportAnswer/Text
Get Report Answer Text in Survey
get__survey__surveyid__reportanswer_text 2 params → 200400401404
GET
/Survey/{SurveyID}/ReportAnswer/Comment
Get Report Answer Comment in Survey
get__survey__surveyid__reportanswer_comment 2 params → 200400401404
GET
/Survey/{SurveyID}/ReportAnswer/Other
Get ReportAnswerOther in Survey
get__survey__surveyid__reportanswer_other 2 params → 200400401404
GET
/Survey/{SurveyID}/ReportIndividual
Get Report of Survey Individual Result
get__survey__surveyid__reportindividual 6 params → 200400401404
GET
/Survey/{SurveyID}/ReportIndividual/{EmailID}
Get Individual Question Result Detail in Survey
get__survey__surveyid__reportindividual__emailid 2 params → 200400401404
GET
/Survey/{SurveyID}/ReportFull
Get full report of Survey
get__survey__surveyid__reportfull 1 param → 200400401404
GET
/Poll/{PollID}/Response
Get Poll response report
get__poll__pollid__response 1 param → 200400401404

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

benchmark-email-reports-api-openapi.yml Raw ↑

Other APIs Benchmark Email publishes across the network.

Benchmark Email ABTest Creation API
Benchmark Email Account Settings API
Benchmark Email Add Contacts API
Benchmark Email Agency Account API
Benchmark Email Archive API
Benchmark Email Automation Creation API
Benchmark Email Contact Configurations & Searches API
Benchmark Email Contact Reports & Metrics API
Benchmark Email Email Editor API
Benchmark Email Email Email Rss Creation API
Benchmark Email Engagement API
Benchmark Email General API
Where this information came from

This is an independent, third-party profile of Benchmark Email Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.