Skip to content

Commit

Permalink
Built release for 4.3.6. For a full change log look at the notes with…
Browse files Browse the repository at this point in the history
…in the original/4.3.6 release.
  • Loading branch information
github-actions[bot] committed May 9, 2022
1 parent e092c0c commit aa42c18
Show file tree
Hide file tree
Showing 29 changed files with 625 additions and 133 deletions.
27 changes: 21 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ The plugin provides a few hooks for you to control the default endpoint data and

**`altis.analytics.consent_enabled <bool>`**

This defaults to if the WP Consent API plugin or a derivative is installed and active by checking if the constant `WP_CONSENT_API_URL` is defined.
This defaults to true if the WP Consent API plugin or a derivative is installed and active by checking if the constant `WP_CONSENT_API_URL` is defined.

**`altis.analytics.data.endpoint <array>`**

Expand Down Expand Up @@ -162,6 +162,12 @@ Insights and aggregated analytics data can be calculated, updated and stored in

Filter the maximum number of days to keep backup data for. The default number of days is 90, in accordance with AWS Pinpoint, after which time data is removed. This is important for streamlining your users' privacy. There is no upper limit on this value, however you should make sure any long term data storage is explained to users when opting in to tracking.

**`altis.analytics.exclude_bots <bool>`**

This defaults to true but can switched off to allow tracking bots that can run JavaScript, note this will affect your data.

You can check if a recorded event was created by a bot by checking if the `attributes.isBot` value exists.

### Functions

**`Altis\Analytics\Utils\query( array $query, array $params = [] ) : array`**
Expand Down Expand Up @@ -346,16 +352,25 @@ use function Altis\Analytics\Audiences\register_field;

add_action( 'init', function () {
register_field(
'endpoint.Location.City', // The Elasticsearch field to query.
__( 'City' ), // A label for the field.
__( 'The closest metropolitan area.' ) // Optional description for the field.
'endpoint.Location.Country', // The Elasticsearch field to query.
__( 'Country' ), // A label for the field.
__( 'The visitor country.' ) // Optional description for the field.
[ // Optional field arguments
'options' => '\\Altis\\Analytics\\Utils\\get_countries', // A callback to provide prepopulated list of options.
'disable_free_text' => false, // Whether to allow free text to be used or to restrict to available options.
]
);
} );
```

In the above example the 1st parameter `endpoint.Location.City` represents the field in the event record to query against. Other examples include `attributes.qv_utm_campaign` or `endpoint.User.UserAttibrutes.custom` for example.
In the above example the 1st parameter `endpoint.Location.Country` represents the field in the event record to query against. Other examples include `attributes.qv_utm_campaign` or `endpoint.User.UserAttibrutes.custom` for example.

The 2nd parameter is a human readable label for the audience field, and the 3rd is the human readable description that goes below the field UI.

The 4th parameter is an optional arguments array, which can include:

The 2nd parameter is a human readable label for the audience field.
- `options` which is a callback that returns a list of valid options, that will complement existing data for that field.
- `disable_free_text` is a boolean to allow/restrict the user to set custom strings rather than choose from the list.

## Required Infrastructure

Expand Down
2 changes: 1 addition & 1 deletion build.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"owner":"humanmade","repo":"aws-analytics","sha":"b33947f5312d7f4077a064e1ed30e8d4caced0ae","ref":"refs/tags/4.0.12","tagName":"4.0.12","branch":"gh-actions","tags":["4.0.12"],"updated_at":"2022-05-09T11:11:25.717Z"}
{"owner":"humanmade","repo":"aws-analytics","sha":"46b5abc7c20f434d90a13be0252f2ab2a13ba4ec","ref":"refs/tags/4.3.6","tagName":"4.3.6","branch":"gh-actions","tags":["4.3.6"],"updated_at":"2022-05-09T11:12:17.104Z"}
24 changes: 24 additions & 0 deletions build/analytics.4dc415e8.js

Large diffs are not rendered by default.

24 changes: 0 additions & 24 deletions build/analytics.b82af12b.js

This file was deleted.

Large diffs are not rendered by default.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

9 changes: 9 additions & 0 deletions build/audiences/ui.4dc415e8.js

Large diffs are not rendered by default.

9 changes: 0 additions & 9 deletions build/audiences/ui.b82af12b.js

This file was deleted.

Loading

0 comments on commit aa42c18

Please sign in to comment.