Reports›Email Activity Report

Email Activity Report

Returns email activity for a date range. It’s the API version of the Email Activity report in Shape.

POSThttps://secure-api.setshape.com/api/reports/email-report/{crmid}

Replace {crmid} with your CRM ID, the Shape system ID that belongs to your API key. Send the standard headers on every request: Authorization: YOUR_API_AUTHORIZATION_KEY and Content-Type: application/json. See Authentication.

This report returns data for the system your API key belongs to. Use the CRM ID and API key for the same system.

Dates are required. See Reports Overview.

Body parameters

Send a filters object holding the report’s filters.

Field Requirement Description
filters Required An object holding the report’s filters.
fromDate Required Start date, YYYY-MM-DD.
toDate Required End date, YYYY-MM-DD.
slctPerPage Optional Results per page. Default 50, maximum 500.
pn Optional Page number, starting at 1.

Example request

{
  "filters": {
    "fromDate": "2026-08-01",
    "toDate": "2026-08-08",
    "slctPerPage": 50,
    "pn": 1
  }
}

Response

  • Results are in Data, with a capital D.
  • Event times that haven’t happened yet show 0000-00-00 00:00:00.