Overview

Use the Send Subscriber OData API to retrieve email send subscriber details, including delivery and engagement counts (opens, clicks), send status, related dealer/workflow context, and the underlying event history for each 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 information.

Authentication

The Send Subscriber 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/SendSubscribers

Send Subscriber OData Data Schema

The information below will be returned in a GET.

Name	Values	Description
Id	Integer	The Aimbase ID of the send subscriber record.
ClickCount	Integer	Total click events recorded for this send subscriber.
OpenCount	Integer	Total open events recorded for this send subscriber.
DeliveryCount	Integer	Total successful delivery events recorded for this send subscriber.
UnsubscribeCount	Integer	Total unsubscribe events recorded for this send subscriber.
SpamComplaintCount	Integer	Total spam complaint events recorded for this send subscriber.
BounceCount	Integer	Total bounce events recorded for this send subscriber.
FailureCount	Integer	Total failures recorded for this send subscriber.
SenderProfileName	String	The sender profile name used for the send.
SenderProfileLocal	String	The sender profile local value used for the send.
CreateDate	YYYY-MM-dd ±hh:mm	The creation date of the send subscriber record.
UpdateDate	YYYY-MM-dd ±hh:mm	The latest update date of the send subscriber record.
Dealer	Navigation Property	The dealer associated to this send subscriber (when available).
LastSendSubscriberEventType	Navigation Property	The latest event type recorded for this send subscriber.
SendStatus	Navigation Property	The current status of the send subscriber record.
Send	Navigation Property	The send record associated with this send subscriber (when available).
SubscriberOptIn	Navigation Property	Subscriber opt-in details for the email address associated with this record.
NotificationQueue	Navigation Property	Notification queue context, including related lead/prospect and workflow information (when available).
SendSubscriberEvents	Navigation Property	Event history recorded for this send subscriber (click/open/bounce/etc.). Typically retrieved via $expand=SendSubscriberEvents.

Expand Options

The Send Subscriber 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.

Rather than duplicating the full field documentation for each related model, this section describes each expandable entity at a high level and provides common usage patterns.

Expand Property	Description	Notes
Dealer	Includes the fields from the associated Dealer model (Id, Name, DealerNbr).	Use when you need dealer identifiers or display name in the same response.
LastSendSubscriberEventType	Includes the latest event type object (Id, Name, Description).	Useful for quickly understanding the most recent subscriber event without expanding all events.
SendStatus	Includes send status details (Id, Code, Name).	Use when you need human-readable status name/code.
Send	Includes the associated Send record, including SentDate, SendStatus, and EmailHtmlContentVersion details.	Can be nested (ex: Send($expand=EmailHtmlContentVersion)).
SubscriberOptIn	Includes subscriber opt-in details (Id, Email).	Use when you need the related subscriber/opt-in record identifier and email value in one call.
NotificationQueue	Includes notification queue context (Id) plus related Lead/Prospect and Workflow objects.	Common for linking send activity back to workflow and lead/prospect context.
SendSubscriberEvents	Includes the full event history (click/open/bounce/etc.) for the send subscriber.	May increase payload size significantly; filter by date or event type when possible.

Sample Queries

Get a Send Subscriber by Id

GET https://{baseurl}/odata/V2/SendSubscribers(114)

Filter by Create Date Range

GET https://{baseurl}/odata/V2/SendSubscribers?$filter=CreateDate%20ge%202026-01-01T00:00:00Z%20and%20CreateDate%20lt%202026-01-06T00:00:00Z&$top=5

Get a Send Subscriber and Expand Send and Email Content Details

GET https://{baseurl}/odata/V2/SendSubscribers(114)?$expand=Send($expand=SendStatus,EmailHtmlContentVersion($expand=EmailType($expand=EmailCategory),SenderProfile($expand=Domain),Email))

Example Response (expanded by Send and Email Content Details)

{
 "@odata.context": "http://test.aimbase.com/odata/V2/$metadata#SendSubscribers(Send(SendStatus(),EmailHtmlContentVersion(EmailType(EmailCategory()),SenderProfile(Domain()),Email())))/$entity",
 "Id": 114,
 "ClickCount": 2,
 "OpenCount": 6,
 "DeliveryCount": 1,
 "UnsubscribeCount": 0,
 "SpamComplaintCount": 0,
 "BounceCount": 0,
 "FailureCount": 0,
 "SenderProfileName": "Test Sender",
 "SenderProfileLocal": "Test-Sender",
 "CreateDate": "2025-10-12T15:53:15.083-05:00",
 "UpdateDate": "2025-10-13T01:26:31.163-05:00",
 "Send": {
   "Id": 584607,
   "SentDate": "2025-10-12T15:53:15.6333333-05:00",
   "SendStatus": {
     "Id": 2,
     "Code": "Sent",
     "Name": "Sent"
   },
   "EmailHtmlContentVersion": {
     "Id": 1348,
     "EmailType": {
       "Id": 1,
       "Code": "Lead Autoresponder",
       "Name": "Lead Autoresponder",
       "EmailCategory": {
         "Id": 1,
         "Code": "Transactional",
         "Name": "Transactional"
       }
     },
     "SenderProfile": {
       "Id": 12,
       "Domain": {
         "Id": 3,
         "Name": "info.testbrand.com",
         "DomainUrl": "info.testbrand.com"
       }
     },
     "Email": {
       "Id": 43,
       "Code": "AutoresponderBAB",
       "Name": "Autoresponder - Build a Bike"
     }
   }
 }
}

Link copied!

Rollick Knowledge