OAITrackingControllerApi

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

MethodHTTP requestDescription
createTrackingPixelPOST /tracking/pixelsCreate tracking pixel
getAllTrackingPixelsGET /tracking/pixelsGet tracking pixels
getTrackingPixelGET /tracking/pixels/{id}Get pixel

createTrackingPixel

-(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]; // createTrackingPixelOptions

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

NameTypeDescriptionNotes
createTrackingPixelOptionsOAICreateTrackingPixelOptions*createTrackingPixelOptions

Return type

OAITrackingPixelDto*

Authorization

API_KEY

HTTP request headers

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

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

getAllTrackingPixels

-(NSURLSessionTask*) getAllTrackingPixelsWithBefore: (NSDate*) before
    page: (NSNumber*) page
    searchFilter: (NSString*) searchFilter
    since: (NSDate*) since
    size: (NSNumber*) size
    sort: (NSString*) sort
        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"];


NSDate* before = @"2013-10-20T19:20:30+01:00"; // Filter by created at before the given timestamp (optional)
NSNumber* page = @0; // Optional page  in list pagination (optional) (default to @0)
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)
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")

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

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

Parameters

NameTypeDescriptionNotes
beforeNSDate*Filter by created at before the given timestamp[optional]
pageNSNumber*Optional page in list pagination[optional] [default to @0]
searchFilterNSString*Optional search filter[optional]
sinceNSDate*Filter by created at after the given timestamp[optional]
sizeNSNumber*Optional page size in list pagination[optional] [default to @20]
sortNSString*Optional createdAt sort direction ASC or DESC[optional] [default to @“ASC”]

Return type

OAIPageTrackingPixelProjection*

Authorization

API_KEY

HTTP request headers

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

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

getTrackingPixel

-(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"; // id

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

NameTypeDescriptionNotes
_idNSString*id

Return type

OAITrackingPixelDto*

Authorization

API_KEY

HTTP request headers

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

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