Get New Subscriber Engagement Stats

POST 
https://api.tinyemail.com/v1/report/audience/new-subscriber-engagement

Retrieves engagement statistics for new subscribers who were added to the specified audiences (identified by audience IDs) and used in the campaign emails within the provided date range. The response includes data such as the number of emails sent, delivered, opened, clicked, unsubscribed, and marked as spam.
Note:

• The maximum date range (difference between from and to) allowed is 7 days.
• The maximum number of segment IDs that can be provided is 10.

Request

application/json

Body

from date-timerequired

"Start date-time for fetching engagement stats in UTC format(yyyy-MM-dd'T'HH:mm:ss). The difference between 'from' and 'to' dates must not exceed 7 days."

to date-timerequired

"End date-time for fetching engagement stats in UTC format(yyyy-MM-dd'T'HH:mm:ss). The difference between 'from' and 'to' dates must not exceed 7 days."

audienceIds uuid[]required

List of audience IDs to filter engagement statistics.

Responses

200

Successful operation

application/json

Schema

Schema

• Array [
date string
audienceName string
sends integer
delivered integer
clicks integer
opens integer
unsubscribe integer
subscribe integer
spam integer
• ]

Example (from schema)

[
  {
    "date": "string",
    "audienceName": "string",
    "sends": 0,
    "delivered": 0,
    "clicks": 0,
    "opens": 0,
    "unsubscribe": 0,
    "subscribe": 0,
    "spam": 0
  }
]

Example

[
  {
    "date": "2025-03-01",
    "audienceName": "Audience 1",
    "sends": 1500,
    "delivered": 1450,
    "clicks": 120,
    "opens": 1300,
    "unsubscribe": 10,
    "subscribe": 500,
    "spam": 5
  },
  {
    "date": "2025-03-02",
    "audienceName": "Audience 2",
    "sends": 1300,
    "delivered": 1280,
    "clicks": 115,
    "opens": 1250,
    "unsubscribe": 15,
    "subscribe": 450,
    "spam": 7
  },
  {
    "date": "2025-03-03",
    "audienceName": "Audience 3",
    "sends": 1700,
    "delivered": 1620,
    "clicks": 135,
    "opens": 1600,
    "unsubscribe": 20,
    "subscribe": 600,
    "spam": 10
  }
]

400

Bad Request

application/json

Schema

Schema

message string

Example (from schema)

{
  "message": "Some error message"
}

401

API key is missing or invalid

405

Method Not Allowed

Authorization: X-API-KEY

name: X-API-KEYtype: apiKeyin: headerdescription: To obtain API-KEY, please contact our customer support by email support@tinyemail.com or directly by chat.

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X POST 'https://api.tinyemail.com/v1/report/audience/new-subscriber-engagement' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'X-API-KEY: <API_KEY_VALUE>' \
--data-raw '{
  "from": "2025-02-01T00:00:00Z",
  "to": "2025-02-08T00:00:00Z",
  "audienceIds": [
    "b6c2f3c4-8f92-4a3d-ae6f-2dbb2c58a28d",
    "d2f84b5e-45cb-4c7a-bd5e-5a47fd55b23a"
  ]
}'

Request Collapse all

Base URL

https://api.tinyemail.com/v1

Auth

api_key

Body

• Example (from schema)
• Example

{
  "from": "2025-02-01T00:00:00Z",
  "to": "2025-02-08T00:00:00Z",
  "audienceIds": [
    "b6c2f3c4-8f92-4a3d-ae6f-2dbb2c58a28d",
    "d2f84b5e-45cb-4c7a-bd5e-5a47fd55b23a"
  ]
}

ResponseClear

Click the Send API Request button above and see the response here!