Scheduled Email & Bulk Blast Report

POST /api/reports/scheduled-emails/{crm_id}

Overview

This endpoint retrieves scheduled email logs for a specific CRM instance within a defined date range.

Note: This report is scoped to a single CRM instance. To query other branches, run the request against each relevant {crm_id}.

Endpoint

  • POST

    https://secure-api.setshape.com/api/reports/scheduled-emails/{crm_id}

Headers

  • Authorization: {SHAPE_API_KEY}

Request Parameters

Send the following parameters in the request body under the filters object:

  • Parameter

    fromDate


    toDate


    slctPerPage


    pn

  • Type

    String


    String


    Number


    Number

  • Description

    Start date of the report (YYYY-MM-DD)

    End date of the report (YYYY-MM-DD)

    Number of results per page


    Page number (for pagination)

Example Request Body

{

  “filters”: {

    “fromDate”: “2025-06-10”,

    “toDate”: “2025-06-15”,

    “slctPerPage”: 5,

    “pn”: 1

  }

}

Sample Response

{

  “status”: 1,

  “msg”: “Success”,

  “data”: [

    {

      “scheduleddate”: “06/14/2025 08:15 AM”,

      “templateName”: “When Should You Refinance?”,

      “username”: “Cindy Kaster”,

      “totalrecords”: 2440,

      “totalDelivered”: “2016”,

      “totalFailed”: “428”,

      “totalBounced”: 0,

      “totalSuppressed”: “100%”,

      “totalOpened”: “177”,

      “totalClicked”: “1”,

      “totalUnsubscribed”: “0”,

      “totalComplained”: “0”,

      “status”: “Completed”

    },

    {

      “scheduleddate”: “06/13/2025 11:50 AM”,

      “templateName”: “Maximize your Home’s Equity!”,

      “username”: “Teddy Wiley”,

      “totalrecords”: 1284,

      “totalDelivered”: “1083”,

      “totalFailed”: “201”,

      “totalBounced”: 0,

      “totalSuppressed”: “100%”,

      “totalOpened”: “68”,

      “totalClicked”: “0”,

      “totalUnsubscribed”: “0”,

      “totalComplained”: “0”,

      “status”: “Completed”

    },

    {

      “scheduleddate”: “06/13/2025 07:56 AM”,

      “templateName”: “Maximize your Home’s Equity!”,

      “username”: “Connor McAtee”,

      “totalrecords”: 1878,

      “totalDelivered”: “1299”,

      “totalFailed”: “580”,

      “totalBounced”: 0,

      “totalSuppressed”: “100%”,

      “totalOpened”: “74”,

      “totalClicked”: “0”,

      “totalUnsubscribed”: “0”,

      “totalComplained”: “0”,

      “status”: “Completed”

    },

    {

      “scheduleddate”: “06/13/2025 05:47 AM”,

      “templateName”: “{Lead.FirstName}, just tried calling!”,

      “username”: “Matt Ogden”,

      “totalrecords”: 3,

      “totalDelivered”: “2”,

      “totalFailed”: “1”,

      “totalBounced”: 0,

      “totalSuppressed”: “100%”,

      “totalOpened”: “0”,

      “totalClicked”: “0”,

      “totalUnsubscribed”: “0”,

      “totalComplained”: “0”,

      “status”: “Completed”

    },

    {

      “scheduleddate”: “06/12/2025 10:39 AM”,

      “templateName”: “Hey {Lead.FirstName}! Lets get you your HELOC options quick!”,

      “username”: “Kerrell Reynolds”,

      “totalrecords”: 4132,

      “totalDelivered”: “2876”,

      “totalFailed”: “1266”,

      “totalBounced”: 0,

      “totalSuppressed”: “100%”,

      “totalOpened”: “314”,

      “totalClicked”: “8”,

      “totalUnsubscribed”: “0”,

      “totalComplained”: “0”,

      “status”: “Completed”

    }

  ]

}

Notes

  • Be sure to replace {crm_id} in the URL with the actual CRM instance ID you want to query.
  • Dates must be in the format YYYY-MM-DD.
  • If you’re paging through a large result set, adjust slctPerPage and pn as needed.

Get started with Shape today