Event API

Events are created once a campaign starts sending. They are associated with a Message and a Contact. Events are used to track the status of a message sent to a contact as well as open rates, unsubscribes, etc.

Get Campaign Events

Get events for a specific campaign with advanced filtering and export capabilities.

Query Parameters:

Required:

• TeamId - string - Team identifier

Optional:

• start - string - Start date (ISO 8601 format, default: 90 days ago or campaign creation)
• end - string - End date (ISO 8601 format, default: today)
• events - string or array - Event types: opened, clicked, replied, bounced, autoresponse
• channels - number or array - Channel types: 1 (email), 2 (linkedin), 5 (twitter)
• limit - number - Number of events to return (default: 25)
• offset - number - Number of events to skip (default: 0)
• email - string - Filter by contact email
• searchText - string - Search in contact name or email
• statuses - array - Filter by event status
• exportContacts - boolean - Set to true to export events
• eventCount - boolean - Get count of events
• reportType - string - Report type for exports

curl -X GET 'https://api.supersend.io/v1/campaigns/<campaignId>/events?TeamId=xxx&limit=50&offset=0&events=replied&channels=1' \
-H "Authorization: Bearer <API_KEY>" \
-H "Content-Type: application/json"

# Response
{
  "success": true,
  "events": [
    {
      "id": "event-uuid",
      "type": 2,
      "channel": 1,
      "opened": true,
      "clicked": false,
      "replied": true,
      "bounced": false,
      "autoresponse": false,
      "subject": "Following up on our conversation",
      "body": "Hi John...",
      "date": "2025-11-27T10:30:00Z",
      "createdAt": "2025-11-27T10:30:00Z",
      "Contact": {
        "id": "contact-uuid",
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "company_name": "Acme Corp"
      },
      "Message": {
        "id": "message-uuid",
        "step_number": 1,
        "subject": "Following up"
      },
      "Sender": {
        "id": "sender-uuid",
        "email": "sales@yourcompany.com"
      }
    }
  ],
  "total": 150,
  "dateRange": {
    "start": "2025-08-29T00:00:00Z",
    "end": "2025-11-27T23:59:59Z"
  }
}