Skip to content

MailSlurp\TrackingControllerApi

All URIs are relative to https://golang.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

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

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createTrackingPixelOptions CreateTrackingPixelOptions

Return type

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 ]

GetAllTrackingPixels

PageTrackingPixelProjection GetAllTrackingPixels(ctx, optional)

Get tracking pixels

List tracking pixels in paginated form

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllTrackingPixelsOpts optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllTrackingPixelsOpts struct

Name Type Description Notes
page optional.Int32 Optional page in list pagination [default to 0]
size optional.Int32 Optional page size in list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]
searchFilter optional.String Optional search filter
since optional.Time Filter by created at after the given timestamp
before optional.Time Filter by created at before the given timestamp

Return type

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 ]

GetTrackingPixel

TrackingPixelDto GetTrackingPixel(ctx, id)

Get pixel

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
id string

Return type

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 ]