Unsubscribes - Fetch

Retrieve a list of unsubscribes for a Mailgun domain using SQL Server

Prerequisites:

See SQLHTTP easy setup for Mailgun
See API Call documentation for parameter values and other information
Create the stored procedure documented below

Stored Procedure:


CREATE PROCEDURE usp_Mailgun_Unsubscribes_Fetch(	
		@Profile nvarchar(100),	
		@Limit int = 100,
		@CurrentURL nvarchar(MAX) = NULL,
		@Response nvarchar(MAX) OUTPUT,
		@StatusCode int OUTPUT,
		@StatusDescription nvarchar(MAX) OUTPUT)

AS

DECLARE @QueryString varchar(MAX)
DECLARE @Password nvarchar(4000)
DECLARE @HTTPSessionID uniqueidentifier

IF @CurrentURL IS NULL
	BEGIN

		SET @CurrentURL = 'https://api.mailgun.net/v3'

		EXEC SQLHTTP.net.UrlBuilder 	@CurrentURL OUTPUT,
						@Profile, 
						'#Domain', 
						'unsubscribes'

	END
		
EXEC SQLHTTP.net.QueryStringBuilder     @QueryString OUTPUT,
					@Profile, 
					'limit', @Limit

SET @CurrentURL = @CurrentURL + @QueryString

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

SET @Password = SQLHTTP.net.AuthParam(@Profile, 'APIKey')

EXEC SQLHTTP.net.BasicAuthHeader @HttpSessionID, 'api', @Password

EXEC SQLHTTP.net.HTTPRequest   @HttpSessionID,
                               @URL = @CurrentURL,
                               @Method = 'GET',
                               @StatusCode = @StatusCode OUTPUT,
                               @StatusDescription = @StatusDescription OUTPUT,
                               @Response = @Response OUTPUT
GO

CREATE PROCEDURE usp_Mailgun_Unsubscribes_Fetch(

@Profile nvarchar(100),

@Limit int = 100,

@CurrentURL nvarchar(MAX) = NULL,

@Response nvarchar(MAX) OUTPUT,

@StatusCode int OUTPUT,

@StatusDescription nvarchar(MAX) OUTPUT)

DECLARE @QueryString varchar(MAX)

DECLARE @Password nvarchar(4000)

DECLARE @HTTPSessionID uniqueidentifier

IF @CurrentURL IS NULL

BEGIN

SET @CurrentURL = 'https://api.mailgun.net/v3'

EXEC SQLHTTP.net.UrlBuilder @CurrentURL OUTPUT,

@Profile,

'#Domain',

'unsubscribes'

END

EXEC SQLHTTP.net.QueryStringBuilder @QueryString OUTPUT,

@Profile,

'limit', @Limit

SET @CurrentURL = @CurrentURL + @QueryString

EXEC SQLHTTP.net.HTTPSession @HTTPSessionID OUTPUT

SET @Password = SQLHTTP.net.AuthParam(@Profile, 'APIKey')

EXEC SQLHTTP.net.BasicAuthHeader @HttpSessionID, 'api', @Password

EXEC SQLHTTP.net.HTTPRequest @HttpSessionID,

@URL = @CurrentURL,

@Method = 'GET',

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT,

@Response = @Response OUTPUT



Sample Usage:


DECLARE @CurrentURL nvarchar(MAX)
DECLARE @Response nvarchar(MAX)
DECLARE @StatusCode int
DECLARE @StatusDescription nvarchar(MAX)

EXEC usp_Mailgun_Unsubscribes_Fetch
		@Profile = 'My Mailgun',
		@Limit = 100,
		@CurrentURL = @CurrentURL,
		@Response = @Response OUTPUT, 
		@StatusCode = @StatusCode OUTPUT, 
		@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400
	EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response
ELSE
	BEGIN

		DECLARE @X xml
		SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

		--The XPath syntax below was easily generated by executing the following commands:
		--EXEC SQLHTTP.net.XQueryHelper @X
		--and then executing: 
		--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/items[1]/JsonObject' -- unsubscribes
		--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/paging' -- URL page navigation
		
		SELECT T.C.value(N'@address', N'nvarchar(MAX)') AS [address]
		      ,T.C.value(N'@tag', N'nvarchar(MAX)') AS [tag]
		      ,T.C.value(N'@created_at', N'nvarchar(MAX)') AS [created_at]
		FROM @X.nodes(N'/JsonObject/items[1]/JsonObject') T(C)

		--Set @CurrentURL to one of the below values (normally @NextURL)
		--and continue calling the above stored procedure to load additional pages
		
		DECLARE @FirstURL nvarchar(MAX)
		DECLARE @LastURL nvarchar(MAX)
		DECLARE @NextURL nvarchar(MAX)
		DECLARE @PreviousURL nvarchar(MAX)

		SELECT @FirstURL = T.C.value(N'@first', N'nvarchar(MAX)')
		      ,@LastURL = T.C.value(N'@last', N'nvarchar(MAX)')
		      ,@NextURL = T.C.value(N'@next', N'nvarchar(MAX)')
		      ,@PreviousURL = T.C.value(N'@previous', N'nvarchar(MAX)')
		FROM @X.nodes(N'/JsonObject/paging') T(C)

	END

DECLARE @CurrentURL nvarchar(MAX)

DECLARE @Response nvarchar(MAX)

DECLARE @StatusCode int

DECLARE @StatusDescription nvarchar(MAX)

EXEC usp_Mailgun_Unsubscribes_Fetch

@Profile = 'My Mailgun',

@Limit = 100,

@CurrentURL = @CurrentURL,

@Response = @Response OUTPUT,

@StatusCode = @StatusCode OUTPUT,

@StatusDescription = @StatusDescription OUTPUT

IF @StatusCode >= 400

EXEC SQLHTTP.net.RaiseHttpError @StatusCode, @StatusDescription, @Response

ELSE

BEGIN

DECLARE @X xml

SET @X = SQLHTTP.net.Json_To_Xml(@Response, '0')

--The XPath syntax below was easily generated by executing the following commands:

--EXEC SQLHTTP.net.XQueryHelper @X

--and then executing:

--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/items[1]/JsonObject' -- unsubscribes

--EXEC SQLHTTP.net.XQueryHelper @X, 'JsonObject/paging' -- URL page navigation

SELECT T.C.value(N'@address', N'nvarchar(MAX)') AS [address]

,T.C.value(N'@tag', N'nvarchar(MAX)') AS [tag]

,T.C.value(N'@created_at', N'nvarchar(MAX)') AS [created_at]

FROM @X.nodes(N'/JsonObject/items[1]/JsonObject') T(C)

--Set @CurrentURL to one of the below values (normally @NextURL)

--and continue calling the above stored procedure to load additional pages

DECLARE @FirstURL nvarchar(MAX)

DECLARE @LastURL nvarchar(MAX)

DECLARE @NextURL nvarchar(MAX)

DECLARE @PreviousURL nvarchar(MAX)

SELECT @FirstURL = T.C.value(N'@first', N'nvarchar(MAX)')

,@LastURL = T.C.value(N'@last', N'nvarchar(MAX)')

,@NextURL = T.C.value(N'@next', N'nvarchar(MAX)')

,@PreviousURL = T.C.value(N'@previous', N'nvarchar(MAX)')

FROM @X.nodes(N'/JsonObject/paging') T(C)

END

address tag created_at

------------------- ------- ---------------------------------

alice@example.com * Sun, 26 Nov 2017 13:35:46 UTC

bob@example.com * Sun, 26 Nov 2017 13:34:00 UTC

carol@example.com * Sun, 26 Nov 2017 13:36:04 UTC



IMPORTANT DISCLAIMER

CODE/SQL ON THESE PAGES ARE PROVIDED AS-IS AND ARE AVAILABLE FOR ILLUSTRATIVE PURPOSES ONLY.

USERS ARE REQUIRED TO ABIDE BY THE TERMS AND CONDITIONS FOR USING REFERENCED THIRD PARTY WEBSITES AND/OR APIs FROM THEIR RESPECTIVE WEBSITES. WE DO NOT CONDONE ANY VIOLATION OF THIRD PARTY WEBSITES AND/OR APIs TERMS AND CONDITIONS USING OUR SOFTWARE.

USERS SHALL BE SOLELY RESPONSIBLE AND BE SOLELY LIABLE FOR VIOLATION OF ANY RULES SPECIFIED BY THIRD PARTIES FOR USING THEIR WEBSITES AND/OR APIs, OR INFRINGEMENT OF RIGHTS OF SUCH THIRD PARTIES.