Skip to content

\TrackingControllerApi

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

create_tracking_pixel

crate::models::TrackingPixelDto create_tracking_pixel(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.

Parameters

Name Type Description Required Notes
create_tracking_pixel_options CreateTrackingPixelOptions [required]

Return type

crate::models::TrackingPixelDto

Authorization

API_KEY

HTTP request headers

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

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

get_all_tracking_pixels

crate::models::PageTrackingPixelProjection get_all_tracking_pixels(page, size, sort, search_filter, since, before) Get tracking pixels

List tracking pixels in paginated form

Parameters

Name Type Description Required Notes
page Option<i32> Optional page in list pagination [default to 0]
size Option<i32> Optional page size in list pagination [default to 20]
sort Option<String> Optional createdAt sort direction ASC or DESC [default to ASC]
search_filter Option<String> Optional search filter
since Option<String> Filter by created at after the given timestamp
before Option<String> Filter by created at before the given timestamp

Return type

crate::models::PageTrackingPixelProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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

get_tracking_pixel

crate::models::TrackingPixelDto get_tracking_pixel(id) Get pixel

Parameters

Name Type Description Required Notes
id String [required]

Return type

crate::models::TrackingPixelDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

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