Skip to content

OAITrackingControllerApi

All URIs are relative to https://api.mailslurp.com

Method HTTP request Description
createTrackingPixel POST /tracking/pixels Create tracking pixel
getAllTrackingPixels GET /tracking/pixels Get tracking pixels
getTrackingPixel GET /tracking/pixels/{id} Get pixel
-(NSURLSessionTask*) createTrackingPixelWithCreateTrackingPixelOptions: (OAICreateTrackingPixelOptions*) createTrackingPixelOptions
        completionHandler: (void (^)(OAITrackingPixelDto* output, NSError* error)) handler;

Create tracking pixel

Create a tracking pixel. A tracking pixel is an image that can be embedded in an email. When the email is viewed and the image is seen MailSlurp will mark the pixel as seen. Use tracking pixels to monitor email open events. You can receive open notifications via webhook or by fetching the pixel.

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


OAICreateTrackingPixelOptions* createTrackingPixelOptions = [[OAICreateTrackingPixelOptions alloc] init]; // 

OAITrackingControllerApi*apiInstance = [[OAITrackingControllerApi alloc] init];

// Create tracking pixel
[apiInstance createTrackingPixelWithCreateTrackingPixelOptions:createTrackingPixelOptions
          completionHandler: ^(OAITrackingPixelDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAITrackingControllerApi->createTrackingPixel: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
createTrackingPixelOptions OAICreateTrackingPixelOptions*

Return type

OAITrackingPixelDto*

Authorization

API_KEY

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getAllTrackingPixelsWithPage: (NSNumber*) page
    size: (NSNumber*) size
    sort: (NSString*) sort
    searchFilter: (NSString*) searchFilter
    since: (NSDate*) since
    before: (NSDate*) before
        completionHandler: (void (^)(OAIPageTrackingPixelProjection* output, NSError* error)) handler;

Get tracking pixels

List tracking pixels in paginated form

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSNumber* page = @0; // Optional page  in list pagination (optional) (default to @0)
NSNumber* size = @20; // Optional page size in list pagination (optional) (default to @20)
NSString* sort = @"ASC"; // Optional createdAt sort direction ASC or DESC (optional) (default to @"ASC")
NSString* searchFilter = @"searchFilter_example"; // Optional search filter (optional)
NSDate* since = @"2013-10-20T19:20:30+01:00"; // Filter by created at after the given timestamp (optional)
NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)

OAITrackingControllerApi*apiInstance = [[OAITrackingControllerApi alloc] init];

// Get tracking pixels
[apiInstance getAllTrackingPixelsWithPage:page
              size:size
              sort:sort
              searchFilter:searchFilter
              since:since
              before:before
          completionHandler: ^(OAIPageTrackingPixelProjection* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAITrackingControllerApi->getAllTrackingPixels: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
page NSNumber* Optional page in list pagination [optional] [default to @0]
size NSNumber* Optional page size in list pagination [optional] [default to @20]
sort NSString* Optional createdAt sort direction ASC or DESC [optional] [default to @"ASC"]
searchFilter NSString* Optional search filter [optional]
since NSDate* Filter by created at after the given timestamp [optional]
before NSDate* Filter by created at before the given timestamp [optional]

Return type

OAIPageTrackingPixelProjection*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]

-(NSURLSessionTask*) getTrackingPixelWithId: (NSString*) _id
        completionHandler: (void (^)(OAITrackingPixelDto* output, NSError* error)) handler;

Get pixel

Example

OAIDefaultConfiguration *apiConfig = [OAIDefaultConfiguration sharedConfig];

// Configure API key authorization: (authentication scheme: API_KEY)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"x-api-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"x-api-key"];


NSString* _id = @"_id_example"; // 

OAITrackingControllerApi*apiInstance = [[OAITrackingControllerApi alloc] init];

// Get pixel
[apiInstance getTrackingPixelWithId:_id
          completionHandler: ^(OAITrackingPixelDto* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling OAITrackingControllerApi->getTrackingPixel: %@", error);
                        }
                    }];

Parameters

Name Type Description Notes
_id NSString*

Return type

OAITrackingPixelDto*

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to ]