Merge pull request #36 from humanmade/audience-ui

Audience UI

Author: roborourke

.circleci/deploy-exclude.txt

@@ -10,5 +10,4 @@
 node_modules
 package.json
 package-lock.json
-src
 webpack.config.js

.circleci/deploy.sh

@@ -62,11 +62,6 @@ fi
 
 rsync -av "$SRC_DIR/" "$BUILD_DIR" --exclude-from "$SRC_DIR/.circleci/deploy-exclude.txt"
 
-# Swap commit placeholders
-SCRIPT_HASH=$(md5sum build/analytics.js | awk '{ print $1 }')
-find . -name '*.php' | xargs sed -i.bak 's/__SCRIPT_HASH__/'"$SCRIPT_HASH"'/g'
-find . -name '*.bak' -delete
-
 # Add changed files
 git add .
 

.eslintrc

@@ -1,7 +1,8 @@
 {
 	"extends": "humanmade",
 	"globals": {
-		"Altis": "readonly"
+		"Altis": "readonly",
+		"wp": "readonly"
 	},
 	"rules": {
 		"no-multi-str": "off",

README.md

@@ -46,6 +46,10 @@ Similar to `registerAttribute()` above but for metrics.
 
 Allows you to define the Elasticsearch server URL directly.
 
+**`ALTIS_ANALYTICS_LOG_QUERIES`**
+
+Define as true to enable logging queries to the error log.
+
 ### Filters
 
 The plugin provides a few hooks for you to control the default endpoint data and attributes recorded with events.
@@ -131,6 +135,9 @@ A user session covers every event recorded between opening the website and closi
     - `ModelVersion`: Browser version.
     - `Platform`: The device operating system.
     - `PlatformVersion`: The operating system version.
+  - `Location`
+    - `Country`: The endpoint's country if known / available.
+    - `City`: The endpoint's city if known or available.
   - `User`
     - `UserAttributes`
       - Any custom attributes associated with the user if known.
@@ -224,6 +231,28 @@ The output will look something like the following:
 
 You can further trim the size of the returned response using the `filter_path` query parameter. For example if we're only interested in the stats aggregation we can set `filter_path=-aggregations.sessions` to remove it from the response.
 
+## Audiences
+
+Audiences are user-defined categories of users, based on conditions related to their analytics data.
+
+Audiences allow for the creation of conditions to narrow down event queries or endpoints but also can be used for determining effects on the client side.
+
+### Mapping Event Data
+
+To enable the use of any event record data in the audience editor it needs to be mapped to a human readable label using the `Altis\Analytics\Audiences\register_field()` function:
+
+```php
+use function Altis\Analytics\Audiences\register_field;
+
+add_action( 'init', function () {
+  register_field( 'endpoint.Location.City', __( 'City' ) );
+} );
+```
+
+In the above example the 1st parameter `endpoint.Location.City` represents the field in the event record to query against. Other examples include `attributes.utm_campaign` or `endpoint.User.UserAttibrutes.custom` for example.
+
+The 2nd parameter is a human readable label for the audience field.
+
 ## Required Infrastructure
 
 A specific infrastructure set up is required to use this plugin:

composer.json

@@ -3,7 +3,8 @@
     "description": "AWS Pinpoint Analytics integration for WordPress",
     "type": "wordpress-plugin",
     "require": {
-        "aws/aws-sdk-php": "^3.103.0"
+        "aws/aws-sdk-php": "^3.103.0",
+        "johnbillion/extended-cpts": "^4.3.2"
     },
     "license": "GPL-2.0-or-later",
     "authors": [