EventsApi.md

EventsApi

All URIs are relative to https://api.sendx.io/api/v1/rest

Method	HTTP request	Description
trackCustomEvent	POST /events/custom	Track custom event
trackRevenueEvent	POST /events/revenue	Track revenue event

trackCustomEvent

EventResponse trackCustomEvent(customEventRequest)

Track custom event

Records custom events for advanced tracking.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.EventsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    EventsApi apiInstance = new EventsApi(defaultClient);
    CustomEventRequest customEventRequest = new CustomEventRequest(); // CustomEventRequest | 
    try {
      EventResponse result = apiInstance.trackCustomEvent(customEventRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EventsApi#trackCustomEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
customEventRequest	CustomEventRequest

Return type

EventResponse

Authorization

TeamApiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	✅ Custom event tracked successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-

trackRevenueEvent

EventResponse trackRevenueEvent(revenueEventRequest)

Track revenue event

Records revenue events for analytics and attribution.

Example

// Import classes:
import sendx_java_sdk.ApiClient;
import sendx_java_sdk.ApiException;
import sendx_java_sdk.Configuration;
import sendx_java_sdk.auth.*;
import sendx_java_sdk.models.*;
import sendx_java_sdk.EventsApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.sendx.io/api/v1/rest");
    
    // Configure API key authorization: TeamApiKey
    ApiKeyAuth TeamApiKey = (ApiKeyAuth) defaultClient.getAuthentication("TeamApiKey");
    TeamApiKey.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //TeamApiKey.setApiKeyPrefix("Token");

    EventsApi apiInstance = new EventsApi(defaultClient);
    RevenueEventRequest revenueEventRequest = new RevenueEventRequest(); // RevenueEventRequest | 
    try {
      EventResponse result = apiInstance.trackRevenueEvent(revenueEventRequest);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EventsApi#trackRevenueEvent");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

Name	Type	Description	Notes
revenueEventRequest	RevenueEventRequest

Return type

EventResponse

Authorization

TeamApiKey

HTTP request headers

• Content-Type: application/json
• Accept: application/json

HTTP response details

Status code	Description	Response headers
201	✅ Revenue event tracked successfully	-
401	❌ Unauthorized - Invalid or missing API key	-
422	❌ Unprocessable Entity - Invalid request format	-
500	❌ Internal Server Error - System error occurred	-