Add IGNORE_URLS for SendPageViewEvent

Author: pyepye

README.md

@@ -64,6 +64,12 @@ MIDDLEWARE = [
 ]
 ```
 
+While using `SendPageViewEvent` if there are certain URLs that you do not want to update Amplitude with you can use the `AMPLITUDE_IGNORE_URLS` setting. This setting take a list of relative urls or URL names. Relative URLS most match exactly so need to start with a forward slash (`/`)
+
+```python
+AMPLITUDE_IGNORE_URLS = ['my_url_name', '/testurl']
+```
+
 
 ### Sending events manually
 

amplitude/middleware.py

@@ -2,7 +2,9 @@
 from time import time
 from uuid import uuid4
 
-from . import Amplitude
+from django.urls import resolve
+
+from . import Amplitude, settings
 from .amplitude import AmplitudeException
 
 log = logging.getLogger(__name__)
@@ -26,6 +28,13 @@ def __init__(self, get_response):
         self.get_response = get_response
 
     def __call__(self, request):
+        # Ignore URLs can be either a url path or url name
+        if request.path_info in settings.IGNORE_URLS:
+            return self.get_response(request)
+        current_url = resolve(request.path_info)
+        if current_url.url_name in settings.IGNORE_URLS:
+            return self.get_response(request)
+
         event = amplitude.build_event_data(
             event_type='Page view', request=request
         )

amplitude/settings.py

@@ -7,6 +7,10 @@
 
 INCLUDE_USER_DATA = getattr(settings, 'AMPLITUDE_INCLUDE_USER_DATA', False)  # NOQA: E501
 INCLUDE_GROUP_DATA = getattr(settings, 'AMPLITUDE_INCLUDE_GROUP_DATA', False)  # NOQA: E501
+IGNORE_URLS = getattr(settings, 'AMPLITUDE_IGNORE_URLS', [])
+if not isinstance(IGNORE_URLS, list):
+    error = '"AMPLITUDE_IGNORE_URLS" must be a list of URLs or URL names'
+    raise ImproperlyConfigured(error)
 
 installed_apps = getattr(settings, 'INSTALLED_APPS')
 middleware = getattr(settings, 'MIDDLEWARE')