Overview

Use the Send Subscriber Events OData API to retrieve individual email send events (such as Delivery, Open, Click, Bounce, Unsubscribe, etc.). This API supports filtering and expansion options so you can query event records and optionally pull related details such as the event type, tracked URL (for click events), and the associated send subscriber record.

This is an OData endpoint and it will support the OData query language. More information about this can be found at odata.org.

Possible Response Codes

200 (OK). This request was successful and information will be returned.
400 (Bad Request). The request is invalid.
401 (Unauthorized). The token is missing, invalid, or expired.
404 (Not Found). The requested record was not able to be found.
500 (Internal Server Error). The request was malformed or some other unspecified error occurred when attempting to retrieve send subscriber event information.

Authentication

The Send Subscriber Events OData API requires authentication. The GET request will require a valid Authenticate message header with an API token. See the Aimbase Authentication API for more information on how to authenticate your request.

Authenticate message header example:

Authenticate: Avala-Api {username}:{token}

Query Information

This OData API allows GET only.

Endpoint for GET

GET https://{baseurl}/odata/V2/SendSubscriberEvents

Send Subscriber Events OData Data Schema

The information below will be returned in a GET.

Name	Values	Description
Id	Integer	The Aimbase ID of the send subscriber event record.
IPAddress	String	The originating IP address for the event (when available).
Country	String	The country code associated with the event (when available).
Region	String	The region/state associated with the event (when available).
City	String	The city associated with the event (when available).
UserAgent	String	The user agent string captured for the event (when available).
DeviceType	String	Device type classification (for example: desktop, mobile) when available.
ClientName	String	Client/browser name (when available).
ClientOS	String	Client operating system (when available).
Code	String	A system code for the event (when available).
Reason	String	Reason details for the event (commonly used for bounces/failures when available).
Description	String	Description details for the event (when available).
CreateDate	YYYY-MM-ddTHH:mm:ss[.fff]±hh:mm	The creation timestamp of the event.
UpdateDate	YYYY-MM-ddTHH:mm:ss[.fff]±hh:mm	The latest update timestamp of the event (may be a default/min value when not set).
WebTrackedUrlId	GUID	The GUID for the tracked URL associated with the event (typically present for click events).
WebTrackedUrl	Navigation Property	The tracked URL object associated with the event (when expanded).
SendSubscriberEventType	Navigation Property	The event type object (for example: Delivery, Open, Click) when expanded.
SendSubscriber	Navigation Property	The send subscriber record associated with the event (when expanded).

Expand Options

The Send Subscriber Events OData API supports several $expand options that allow you to retrieve additional related data by expanding associated models. This can help reduce the number of separate API calls needed and ensure that you have access to detailed, related information directly within the response.

Expand Property	Description	Notes
WebTrackedUrl	Includes the tracked URL details (UrlFormat, UrlTitle, Score, IsCta).	Most useful for Click events where WebTrackedUrlId is populated.
SendSubscriberEventType	Includes the event type details (Name, Description).	Common for filtering by type and returning readable names in the response.
SendSubscriber	Includes the associated send subscriber record and its related context (when expanded further).	Avoid circular expansion (ex: SendSubscriberEvents inside SendSubscriber) to prevent large payloads or server errors.

Sample Queries

Get a Send Subscriber Event by Id

GET https://{baseurl}/odata/V2/SendSubscriberEvents(11346572)

Example Response

{
  "@odata.context": "http://{baseurl}/odata/V2/$metadata#SendSubscriberEvents/$entity",
  "Id": 11346572,
  "IPAddress": null,
  "Country": null,
  "Region": null,
  "City": null,
  "UserAgent": null,
  "DeviceType": null,
  "ClientName": null,
  "ClientOS": null,
  "Code": null,
  "Reason": null,
  "Description": null,
  "CreateDate": "2026-01-08T00:58:43-06:00",
  "UpdateDate": "0001-01-01T00:00:00-06:00",
  "WebTrackedUrlId": null
}

Filter Send Subscriber Events by Event Type Name (top 5)

GET https://{baseurl}/odata/V2/SendSubscriberEvents?$expand=SendSubscriberEventType&$filter=SendSubscriberEventType/Name eq 'Delivery'&$top=5

Example Response (filtered and expanded by SendSubscriberEventType)

{
  "@odata.context": "http://{baseurl}/odata/V2/$metadata#SendSubscriberEvents(SendSubscriberEventType())",
  "value": [
    {
      "Id": 7,
      "IPAddress": null,
      "Country": null,
      "Region": null,
      "City": null,
      "UserAgent": null,
      "DeviceType": null,
      "ClientName": null,
      "ClientOS": null,
      "Code": null,
      "Reason": null,
      "Description": null,
      "CreateDate": "2018-04-19T07:22:38-05:00",
      "UpdateDate": "0001-01-01T00:00:00-06:00",
      "WebTrackedUrlId": null,
      "SendSubscriberEventType": {
        "Id": 7,
        "Name": "Delivery",
        "Description": "Delivered email"
      }
    }
  ]
}

Get a Send Subscriber Event and Expand WebTrackedUrl

GET https://{baseurl}/odata/V2/SendSubscriberEvents(11345113)?$expand=WebTrackedUrl

Example Response (expanded by WebTrackedUrl)

{
  "@odata.context": "http://{baseurl}/odata/V2/$metadata#SendSubscriberEvents(WebTrackedUrl())/$entity",
  "Id": 11345113,
  "IPAddress": "98.37.132.51",
  "Country": "IN",
  "Region": "TS",
  "City": "Hyderabad",
  "UserAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/142.0.0.0 Sa",
  "DeviceType": "desktop",
  "ClientName": null,
  "ClientOS": "Windows",
  "Code": null,
  "Reason": null,
  "Description": null,
  "CreateDate": "2025-12-08T09:32:31-06:00",
  "UpdateDate": "0001-01-01T00:00:00-06:00",
  "WebTrackedUrlId": "53be51ac-1dc9-4ccc-bc59-05e8d8f2ce41",
  "WebTrackedUrl": {
    "Id": 0,
    "UrlFormat": "http://www.traversebikes.com/inventory",
    "UrlTitle": New Inventory,
    "Score": 10,
    "IsCta": true
  }
}

Link copied!

Rollick Knowledge