MailSlurp::TrackingControllerApi
Load the API package
All URIs are relative to https://api.mailslurp.com
Method | HTTP request | Description |
---|---|---|
create_tracking_pixel | POST /tracking/pixels | Create tracking pixel |
get_all_tracking_pixels | GET /tracking/pixels | Get tracking pixels |
get_tracking_pixel | GET /tracking/pixels/{id} | Get pixel |
TrackingPixelDto create_tracking_pixel(create_tracking_pixel_options => $create_tracking_pixel_options)
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
use Data::Dumper;
use MailSlurp::TrackingControllerApi;
my $api_instance = MailSlurp::TrackingControllerApi->new(
# Configure API key authorization: API_KEY
api_key => {'x-api-key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'x-api-key' => 'Bearer'},
);
my $create_tracking_pixel_options = MailSlurp::Object::CreateTrackingPixelOptions->new(); # CreateTrackingPixelOptions |
eval {
my $result = $api_instance->create_tracking_pixel(create_tracking_pixel_options => $create_tracking_pixel_options);
print Dumper($result);
};
if ($@) {
warn "Exception when calling TrackingControllerApi->create_tracking_pixel: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
create_tracking_pixel_options | CreateTrackingPixelOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageTrackingPixelProjection get_all_tracking_pixels(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before)
Get tracking pixels
List tracking pixels in paginated form
Example
use Data::Dumper;
use MailSlurp::TrackingControllerApi;
my $api_instance = MailSlurp::TrackingControllerApi->new(
# Configure API key authorization: API_KEY
api_key => {'x-api-key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'x-api-key' => 'Bearer'},
);
my $page = 0; # int | Optional page in list pagination
my $size = 20; # int | Optional page size in list pagination
my $sort = 'ASC'; # string | Optional createdAt sort direction ASC or DESC
my $search_filter = "search_filter_example"; # string | Optional search filter
my $since = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at after the given timestamp
my $before = DateTime->from_epoch(epoch => str2time('null')); # DateTime | Filter by created at before the given timestamp
eval {
my $result = $api_instance->get_all_tracking_pixels(page => $page, size => $size, sort => $sort, search_filter => $search_filter, since => $since, before => $before);
print Dumper($result);
};
if ($@) {
warn "Exception when calling TrackingControllerApi->get_all_tracking_pixels: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
page | int | Optional page in list pagination | [optional] [default to 0] |
size | int | Optional page size in list pagination | [optional] [default to 20] |
sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to 'ASC'] |
search_filter | string | Optional search filter | [optional] |
since | DateTime | Filter by created at after the given timestamp | [optional] |
before | DateTime | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]
TrackingPixelDto get_tracking_pixel(id => $id)
Get pixel
Example
use Data::Dumper;
use MailSlurp::TrackingControllerApi;
my $api_instance = MailSlurp::TrackingControllerApi->new(
# Configure API key authorization: API_KEY
api_key => {'x-api-key' => 'YOUR_API_KEY'},
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#api_key_prefix => {'x-api-key' => 'Bearer'},
);
my $id = null; # string |
eval {
my $result = $api_instance->get_tracking_pixel(id => $id);
print Dumper($result);
};
if ($@) {
warn "Exception when calling TrackingControllerApi->get_tracking_pixel: $@n";
}
Parameters
Name | Type | Description | Notes |
---|---|---|---|
id | string |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
[Back to top] [Back to API list] [Back to Model list] [Back to ]