MailSlurpTrackingControllerApi

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

TrackingPixelDto CreateTrackingPixel(ctx, createTrackingPixelOptions)

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.

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createTrackingPixelOptionsCreateTrackingPixelOptionscreateTrackingPixelOptions

Return type

TrackingPixelDto

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

PageTrackingPixelProjection GetAllTrackingPixels(ctx, optional)

Get tracking pixels

List tracking pixels in paginated form

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAllTrackingPixelsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllTrackingPixelsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page in list pagination[default to 0]
searchFilteroptional.StringOptional search filter
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in list pagination[default to 20]
sortoptional.StringOptional createdAt sort direction ASC or DESC[default to ASC]

Return type

PageTrackingPixelProjection

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

TrackingPixelDto GetTrackingPixel(ctx, id)

Get pixel

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
idstringid

Return type

TrackingPixelDto

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 ]