Manuals and Videos

API documentation is public. Typically the API will be used by more technical users. 

 

Click on below link to access Profile Cloud API guide.


https://innometrics.atlassian.net/wiki/display/ID/profile+api


This is the full user manual for the Web Data Collection App within Profile Cloud. We recommend going through the Getting Started area of the Knowledge Base before reading this full manual. In this manual, we cover how to create users, set up Buckets and Sections inside Profile Cloud and collect data in Events.  


1.  Getting Started & Setting Up Your Accounts


1.1 Login                                

Login activation email
You should have received your login details in an email.
  • Company
  • Username
  • Temporary password
Login activation email

Choose a password
You can choose your password by clicking on the link in the activation email
Choose a password

Login 

Use the following URL to login: https://profilecloud.apsis1.com/
APSIS website

APSIS login screen

Here you are able to now sign-in with your details for: 
  • Company
  • Username
  • Password

 

 


 

Login screen



  1. Company is connected to your account in APSIS. This is also the company name that you designated in your service activation details.
  2. Username is unique to you
  3. Password is unique to you
  4. Click here to sign-in
  5. Password reset button
  6. Help topics that are linked to the FAQ


Retrieve password and/or login


From the login page (customer.innometrics.com) please click on “Forgot your password?”

This will then take you to the Reset password form. Enter your “Company” and “Username”.




1.2 Main Navigation


1) Navigation bar
5) Visualize Apps
9) Buckets
2) Create new event, page, or site
6) Share Apps
10) Account
3) Collect apps
7) Apsis
11) Help section
4) Enrich Apps
8) App store

 

  1. THE NAVIGATION BAR on the top of the page allows you to navigate and access the different pages in your App.
  2. The “+” menu depending on your permission level and selected App the plus sign is a shortcut to create new things such as create new- event, user, site, building block, etc.
  3. COLLECT APPS are used for collecting data within the APSIS system.
  4. ENRICH APPS is where you will find apps for adding more advanced value to your collection data.
  5. VISUALIZE APPS is where you will find apps for showing information about user behavior etc. Most commonly used are Profile overview and Statistics for showing app events.
  6. SHARE APPS is where you can find your active share apps. Share apps are used for sending data to another system or provider.
  7. Apsis is where you will find APSIS apps.
  8. APP Store here you will find all the available apps for activation/deactivation.
  9. Buckets menu is where you select what website to work with, depending on whether you have multiple section setups in your account or not. All the events and settings visible in the account will correspond to the website selected in this menu. If you switch section, you will see a new environment with the events and settings corresponding to that particular site.
  10. MY ACCOUNT is where you manage your account settings. If you are the company administrator, this is where you manage permission levels for your users.
  11. HELP section is where you can find more info when you have questions or need help.

1.3 How to Put APSIS Code on Your Site (for developers)


What is a section?

A “section” in web data collection corresponds to a website that has the APSIS tag included in its code. The APSIS platform can be quickly implemented on your site by copying the tag contained in your APSIS account and putting in on your site.


Step 1) Copy the tag from your APSIS account (Deploy page)

Company administrators and users with sufficient permissions can access the Settings page in Collection Apps > APSIS Web Data Collection > Settings. Once on the Settings page, copy the APSIS tag shown on the bottom right of your screen. Please note that the APSIS tag is specific for every section.

 

 

Step 2) Paste the tag in your website’s code

The tag must then be included on the website. To do this, place the tag within the website's code. Sometimes tags can also be added in the CMS of your website, without touching the code directly. The tag must be placed on every page of the website, which is usually done by placing it in a global header. The recommended placement of the tag is inside the <head>...</head> HTML tags on your website.

 

 

Technical details

If your website uses jQuery, it is recommended that APSIS is loaded after jQuery is loaded. APSIS will still work but you may find yourself with jQuery library being loaded twice, which imposes a small but unnecessary overhead on your visitors. In the vast majority of cases, the loading order is not a concern because jQuery is usually loaded synchronously and therefore will be loaded before APSIS. If however your website loads jQuery asynchronously or with a .html defer tag, you may want to contact ClientCare to make sure the loading is the optimal one.


1.4 How to Setup Sections

The most common setup is to have only one section in your account. There are, however, exceptions to this. For instance, if you own multiple websites you will need to connect each domain to a separate section in your account. We recommend that different domains or platforms be connected to separate sites. You can then switch between these sections in your account depending on which one you are working on. You can switch between sections by using the highlighted drop-down menu.


Please note that in this example the company account has demo site:


Multiple websites

 

 

1.5 How to Setup Apps


What is an App?

Apps are the products you have licensed for the platform such as the Enhanced Web Analytics App for Adobe Analytics or Google Analytics or the E-mail Retargeting App. Apps determine what actions your events will have and what you want to do with the data that you have captured.


1) The Apps page
2) The event builder Page


                                                   

Activating Apps


1) The App Store page

All of your purchased apps will appear on the apps setup page. However, they need to be activated before you can use your app in an event. In most instances, APSIS will already have activated the Apps. In the event that they are not activated, you will need to activate them on the App store page.

To enable an app, click on “Read More” and then “Install button”.

Each app individual settings are explained in the separate Apps Appendix. Note that changing the settings for an app might affect your event setup. Consult with ClientCare if you don’t see your purchased app.


2) The Event creation builder page

Once activated, your app will appear in the menu Collection Apps/Enrich Apps/Visualize Apps/Share App, depending on what type of app has been activated. To access the event creation builder select Collection Apps > Web Collection App. click on the “+” and select New Event after you have selected your app in the navigation menu.


Please note: If you would like to purchase additional apps, please contact ClientCare.


 

1.6 How to Manage Users and Enable Administrator Rights

Company administrators can create new users in a company. If you are a company administrator, click Account in the navigation bar and then Administration. This will then take you to the Admin page for user and administration rights editing.

 

How to set up a new user

Click on the “+” symbol to set up a new user.


User status

You can choose to create a new:

  • ADMIN: the new user will have the same permissions as you have. He will be able to create new sites, add Apps or create new users himself.
  • USER: if you set the status to User, the user will not be able to perform any administrative tasks. He will be able to create and edit events and deploy them following the detailed permissions you set.
  • DISABLED: if you set the user to Disabled, the user will not be able to log in, however, they will still appear in the system.

User permissions

If you set the status to User, you can set detailed permissions for the user.

  • You can define which sites the user will be able to access
  • For every site that a user is granted access to, you can define if the user should be able to edit only or edit and deploy. If the user can edit only, he will be able to create events, edit existing events and test them in development mode. If the user also can deploy, he will get access to the Deploy screen from which he can actually deploy changes to the live site.



2. Building Events


2.1 The Event Creation Builder

What is an event?

An event defines a behavior on your site. The event creation builder is where you create your events and assign an app to determine how you want to use this data.


What is a segment?

A segment is a combination of more than one behavior.


1) Name and category

4) Segment area

7) Trigger area

10) Event data area

2) Building blocks

5) Save

8) Condition area

11) Session data area

3) Apps

6) Deploy event

9) Tag area

12) Profile attributes area

 


The building blocks

These are used to build an event (located in the left sidebar in the event builder).

 

1) Trigger
3) Data
2) Conditions
4) Tags



Building blocks - explanation

Triggers

Triggers define the interaction that triggers the event. We always recommend beginning with a trigger block when building an event as it is mandatory to have a trigger when saving the event.

Example: page load, In-page interaction.

 

Conditions

A condition will filter the event and define under which circumstances the event should be executed. Conditions are often connected to the value block in order to verify a particular value before activating the event. You can manually connect them using the wire function.


Example: restrict the event to a certain page e.g. my home page. If my value is 20 seconds, will the event be triggered before or after? If my value is three clicks, am I interested in more than three or three exactly?

Data 

Data defines the type of data that will be captured and added to the visitor’s profile. The data can be added to three different categories.

  • Event Data: event data is the least permanent type of data relating to individual events such as page load or click through.
  • Session Data: is data related to a specific session such as what device the visitor is using during this session.
  • Profile Attributes are attributes about the visitor that fixed over a longer period of time such email address or home address.

   

Tags

The products you have licensed. Only the tags activated for this site will appear in this menu. Tags can be connected/wired to values. For more information about the particular apps available, please refer to the apps Appendix.


The building area

This is where you build your events. This is done by dropping your building blocks in the corresponding color field.

1) The area where you drop your segments to apply them to the event

2) The area where you build events - .trigger, condition (optional), value (optional) and App

 

How to build an Event

  1. The first thing you want to do is to choose a descriptive name and category for your event.
  2. The left sidebar is a menu containing the building blocks for building events. These are the technical features we provide to help you identify visitor behavior on your site.
  3. Tags/Apps determine how your data is used and what to do with the identified behavior.
  4. To build an event, simply drag the blocks out of the menu and drop them in the canvas on the corresponding color field.
  5. Save your event.
  6. Go to the deploy page to first test that your event works using DEV mode and then deploy it live on your site.


How to save data to Profile Cloud

When building the as above simply double-click on the Event/Session data or profile attribute that you want to be stored in profile cloud instead of the user's browser. Then tick the box “add the event data to your cloud profiles” and press ok.


2.2 On-Site Widget

What is the On-site Widget?

The On-site Widget (as displayed below) allows you to manually select certain elements on your site that you want to use in your event.



Installing the On-site Widget bookmarklet

To be able to use the On-site Widget, make sure you have the bookmarklet in your bookmarks bar. The bookmarklet is installed by dragging the bookmarklet link (from the settings of the building block that requires the use of the widget) to your browser’s bookmark bar.




 

How to install the On-site Widget

1. Drag the bookmarklet link to your bookmark bar.

2. The bookmarklet will look like any other bookmark in your bookmark bar. Keep it there for the next time you are building an event.


How to use the On-site Widget

1. To use the On-site Widget, start in the event builder and select one of the building blocks connected to the On-site Widget:

  • In-page interaction
  • Value from page
  • Scroll to element


2. Drag one of these building blocks to the corresponding area and click on it. You will now be asked for the URL of the page for which you want to apply the On-site Widget. Insert a URL and click GO.


3. Now the last step is to click on the bookmarklet you have previously added. Clicking the bookmarklet will open the On-site Widget and will allow you to interact with your page.


2.3 Testing and Validating with Bookmarklets

How to test

Before you deploy your events live on your site, you need to test that they work. This is done by using the Dev mode and Live mode bookmarklets, which are located on the settings page as shown below. They will look like regular bookmarks in your bookmark bar, however, they have JavaScript in them that enables you to test your events in a so-called “development” file, which is only visible locally, before being deployed live to the rest of the visitors of your website.


Steps:

  1. To get started, drag the bookmarklets from the settings page to your bookmark bar.

  2. Then click the Dev mode bookmarklet to test your events. Each time you save an event it will automatically be saved in a development file, which always contains your latest changes. You can test these any time on your site by clicking on your Dev mode bookmarklet. Dev mode will run all the current events in your account but they remain inactive for other visitors until you deploy them to the live environment.

  3. Always end your testing by clicking the Live mode bookmarklet in order to exit from the development environment and back to live mode – that is, what visitors to your website can see.


Why test?
Development/Live files give you more control by allowing you to choose when you want to deploy your changes to the Live file.


 

2.4 Deploying Events


1. Log of activity in the account (located on left)

Keep track of recent changes to your events in the log on the left. When you have tested your events in your account using the Dev-file bookmarklet, it is time to deploy them.


2. Deploy to live (button)

Deploy your events live on your website. Write a comment to remember what version you deployed in case you want to edit this part of your events in the future.


3. Log of versions that have been pushed to live (located on right)

The version (of events deployed) on the top of this list is always the version that is currently live on your site.

4. Restore to live (button)

This will revert the state of the events deployed on your website to live. If you have previous versions, you can click on this button to restore the live version on your website. Only one version can be live, which is always the top one in the list.

Example: You have found an error in “version 2” and can’t correct it so you want to go back to the previously deployed state of “version 1”. Click on the “Restore to live” button on “version 1”, this will reset the events to the state they were in when “Version 1” was deployed. Now you can try again.


5. Restore to dev (button)

This will revert the state of the events in your account to a previous state. All the events in your account will be restored to this version and editable from there. (Nothing will happen to the version live on your website) 

Example: You want to edit something in a previously deployed version. Click on “Restore to DEV” on the version you want to edit and all your events will revert to the previous state in that version. Now you can build on from this state




3. Examples of Events & Segments


3.1 Examples of events

The purpose of the event builder is to allow you to identify visitor interactions and to connect this data with an App that determines what you want to do with it. Here are the steps for creating a new event:

  1. Click on the collect app and select web data collection
  2. Click on the plus sign in the left corner and select New event
  3. Give your event a name
  4. Add a trigger
  5. Optionally, add values and conditions
  6. Add an App
  7. Optionally, add a segment
  8. Test in DEV-mode and then deploy it live


EXAMPLE 1: How can I restrict my event to only work on a particular page or site section?


When you want to put any restriction on your event, wire your event data to a Condition. For example, to restrict your event to a particular page or site section, pick a Value from the "Page" category, in this case, “Page URL”, and wire it to your condition “Value is equal to” as done below.

Building Blocks:
Trigger: In-page interaction submit.
Condition: Value is equal to.
Event data: Page URL.
App: Choose your App depending on what you want to do with this data.




 

 

EXAMPLE 2: How do I use dynamic values in my event? (On-site Widget example)


If you want to use a dynamic value in your event, use the "Value from page" building block in the events data menu. For instance, you want to identify all the visitors who search for "shoes" on your website's internal search. 
Building Blocks:
Trigger: In-page interaction.
Condition: Value contains.
Event data: Value from page.
App: Choose your App depending on what you want to do with this data.

 

  1. Use the trigger "In page interaction", then use the On-site Widget to select the search button as your trigger and choose click as your interaction.


  2. Use the condition "Value is equal to" and type in "shoes" as your value.


  3. Use the data "Value from page" and using the On-site widget again, select the search field to define this as an element where the “value” is entered.


Now you have identified the segment of visitors who type in "shoes" in your search field using dynamic values.


3.2 Examples of segments

What is a segment?

In APSIS, a segment is an evolution of an event. You can combine multiple events to form a segment. Segments are useful when you want to identify visitors not only based on a single interaction but also based on a combination of interactions.

For instance, a segment could be created to identify visitors who have repeatedly shown interest in a product on an e-commerce site. Such a segment would be built by combining different interactions (visiting the product page, recommending it through social widgets, adding it to cart, etc.), defining the number of times the interactions must be performed and during which time period.


How to build a segment?

A segment is a combination of events happening during a timeframe. When you have created a segment you can then use it as an advanced condition in an event. A segment could, for example, be an event triggered twice during a session. You can find all your created segments in Enrich App > Segmentation > Segments. But before you can use an event in a segment you first need to add it to sync with the profile cloud. So before you add the event in a segment open your event, press settings icon and then choose sync with Profile Cloud to yes. Now you will be able to find your event in the Segment editor.


To create a segment, first, go to your Enrich App > Segmentation > Segments page. Click on “+” Create new segment to enter the editor. In the Segment editor, you will find all your Events and data that are synced to profile cloud in the left area. Double click or drag your Events or Data to their respective sections. Double click on the section block to choose what data to use, when it has to have happened and how often it needs to be triggered. Before you can use your Segment you have to add a name and then press Save button. Now you will be able to use the segment in your events as an advanced segment condition.



The attached guide can be downloaded here Implementation guide for developers to implement Profile Cloud web data collection script

For further assistance please contact support@apsis.com


Introduction

 

This document is prepared for APSIS tag implementation. As the result of this configuration, APSIS customers will be able to take advantage of various APSIS apps and plugins.


The APSIS JavaScript inclusion file contains the code necessary to operate web analytics program and should be included on required pages of the customer website. It has been configured to capture the data required to generate reports in agreed report specification.


For new customers, the JavaScript file might at first appear empty, containing only a JavaScript comment. This is perfectly normal and the file will be filled with the code necessary to operate the analytics program once all details have been decided between you and your account manager.


APSIS JavaScript file uses the Akamai Content Delivery Network for its distribution. Akamai is recognized as the largest and fastest network in the world, operating 100,000 servers in 71 countries to ensure fast delivery in all locations. The JavaScript file is loaded asynchronously; it is perfectly invisible for the visitors of the website and does not impact the rendering of the pages.


For more information about Akamai: http://www.akamai.com


Implementation

On every page of target website, place APSIS tag AFTER inclusion of jQuery library. We recommend placing the tag in the head section of HTML code, as it is optimal for onsite personalization cases.


Example Implementation:


<script type="text/javascript" src="/javascripts/jquery/1.9.1/jquery-
1.9.1.js"></script>
<script type='text/javascript'><!--
(function () {
var swDc = document.createElement('script');
swDc.type = 'text/javascript';
swDc.charset = 'UTF-8';
swDc.async = true;
swDc.src = ('https:' === document.location.protocol) ?
'https://a248.e.akamai.net/swordfishinc.download.akamai.com/145199/live/p/167/37b70
cd3.js' : 'http://media.swordfishdc.com/live/p/167/37b70cd3.js';
var a = document.getElementsByTagName('script')[0];
a.parentNode.insertBefore(swDc, a);
}());
--></script>

 </head>


Note that if APSIS is planned to work on top of existing solutions, i.e. cooperate with existing Web Analytics tracking code for reporting, please contact APSIS for specific instructions.


Including a code snippet on different pages is usually done by placing it in CMS platform that your website is based on. For any technical question please contact your account manager. It is recommended that this script should be firstly deployed in test/dev environment; APSIS will help validate the tag deployment before production.


Your APSIS tag code is also included in the attached tag.txt file.

Preamble 


This document will describe how users can be added/removed to/from an audience by firing FB Custom Events through APC.


The Facebook (FB) Pixel provides several different means for adding and removing users to and from an audience based on the different actions that the user takes during their visit to a site, and it is mainly being controlled through triggering different FB Events. Users within a given audience can be included/excluded on the basis of these FB Events having fired or not within a given time period.


Here, we are making a distinction between Apsis Profile Cloud (APC) Events and FB Events. These aren’t to get mixed up - the APC Event is used to determine when to trigger a FB Event towards the FB API.



Adding/Removing Users to a Facebook Audience through Profile Cloud


In order to add/remove users to/from an audience through APC, two APC Events will be needed firing to trigger two different FB Events within FB for including/excluding the user from the audience in question.



Adding a user to a Facebook Audience by firing the pixel (Profile Cloud)


In order to start adding users to a given audience, an event needs to be prepared within APC to trigger at the desired interaction/moment.

Let us start by creating an example event that can be used for testing the tag. A new event can be created by going to Collect -> Web Data Collection, then clicking the Events tab (next to Dashboard), and click “Create new event definition”.  A dialogue box will then open asking for an Event name, ID and category.


Figure 2.1.1: Event creation dialogue box


As can be seen in figure 2.1.1, the event name used in this example is “Frequent Visitor” and the category used is “social media”. The ID will be filled out automatically as the event name is being entered. A short description is also being used to describe the event. This is not a requirement, however.

This event will will trigger as the user lands on the site and match a segment of being a frequent visitor. The event will extract two profile attributes: “Lifetime Total Spend”, the total amount spent by the user on our site during the profile lifetime, and “Favorite Product Category”, their favorite product category (determined either by survey or through scoring). Lastly, a FB Custom Event will be sent to FB containing information on what type of event that has taken place and what relevant data that has been collected together with it.

For the event, an appropriate trigger is needed. In this example we will use the Page Load trigger (see figure 2.1.2). This means that the event will trigger as the page is loaded.

Figure 2.1.2: Adding the Page Load trigger to the event


We will then need to add a segment to our event, to make sure that it only fires for users that belong to this segment. In this case, we will add a “Frequent Visitor” segment (see figure 2.1.4). This segment includes anyone that has had five “New Visit” (APC) events during the latest month, thus making them frequent visitors.


Figure 2.1.4: Our segment


Within each event that is meant to add a user to a given audience, the FB Custom Event tag is also needed. This tag can, as with the Page Load trigger, be found in the left hand menu of the event builder page (see figure 2.1.4). Once the tag has been found in the menu, drag and drop it (or double-click it) and place it within the Tags area of the event builder.

Figure 2.1.4: Adding the Custom Event tag to the event


Now we have an FB Custom Event that will fire as the page is loaded for anyone that is a frequent visitor. However, we need to do one more thing to fulfill our exempel case: we need to collect the data that we want to send along as parameters for the FB Custom Event.

By using the Get Profile Attribute building block (BB), we can extract any profile attribute from the profile to send to the tag. In this case, we are interested in two profile attributes: “Lifetime Total Spend” and “Favorite Product Category”. Add these to the event and then connect them to the tag (see figure 2.1.5).


Figure 2.1.5: Connecting the two BBs to the tag


The last thing to do is to fill out the tag parameters properly. The tag has seven available parameters: Event Name, together with three optional (static or dynamic) custom parameters (name and value) that can be sent along with the request (see figure 2.1.5). For our exemple case, we only need two of these three custom parameters. Preferably, the Restrict per session condition is also added to the event to prohibit from triggering with each page being loaded.


The Event Name parameter is used to tell FB what type of Custom Event has just been fired and it is a required parameter. Here, we will use “FrequentVisitor” as the event name. As Custom parameter 1 name we will use “lifetime_total_spend” to signal to FB the name of the first parameter of the Custom Event. As Custom parameter 1 value we will use our dynamic value for the Lifetime Total Spend profile attribute which we connected to the tag earlier. The same process goes for the Custom parameter 2 name (and value), but here we use “favorite_product_category” as the name (and the corresponding profile attribute as the value). Since we don’t have any third parameter, we will live this one blank. The order of these parameters is completely arbitrary.


Figure 2.1.5: The FB Custom Event parameters



Removing a user from a Facebook Audience by firing the pixel (Profile Cloud)


Here, the procedure is essentially the same as when adding users to the audience: an event needs to be fired at the intended time as the user has taken a desired action on the site, but here we remove them from the same FB Audience instead. What controls the exclusion of users from segments is, as with the inclusion of a user, the Custom Event name and/or its parameters. Also, as with the event that adds user to the audience, a condition is preferably added to make sure that a Custom Event is only generated once per session.


A good example of when a user should be removed/excluded from the same audience we just added a user to is when he/she lands on the site and isn’t considered as a frequent visitor anymore. For this flow, we can create an event, use the same trigger (Page Load), add the same segment but negated instead (see figure 2.2.1), and lastly add the Custom Event tag with the Event Name “NonFrequentVisitor” (see figure 2.2.2). No custom parameters will be needed here.


Figure 2.2.1: Negating the “Frequent Visitor” segment


Figure 2.2.2: “Non-Frequent Visitor” Custom Event parameters




Preparing the Audience in the Ads Manager (Facebook)


In order to be able to add the users to an audience, a new website traffic audience has to be created and configured to include users that have triggered our “FrequentVisitor” Custom Event and to exclude those that have triggered the “NonFrequentVisitor” event. This can be done by creating a Custom Audience with corresponding inclusion/exclusion rules for the mentioned Custom Events (see figure 2.3.1).


Figure 2.3.1: Setting up the FB Audience


This should lead to the audience being kept balanced as frequent users are added to the audience as soon as they interact with the site and match the APC Segment “Frequent Visitors”, and excluded once they land on the site and don’t match the segment anymore.



Validating that requests are being sent to Facebook


By opening the Network tab in your browser (after triggering the APC Event and without reloading/changing the page) and filtering the traffic on “facebook”, you should be able to see the request being sent with a 200 OK status code in the response. (see figure 3.1).

Figure 3.1: Request sent to FB