Developers

WRITE

HIP Tag & Badge

Collect the data you want using the HIP tag. Get reports on data that matters to you.

Proudly display the HIP Badge to let your users know you support their right to share control of the data you collected about them.

The HIP tag can be used to fully replace current methods of user tracking such as cookies or server side profiles, or used as a complementary solution to such techniques.

HIP Tag Applications

Both website publishers and online advertisers can use the HIP Tag & Badge to collect user data and to share control of that data with users.

HIP Tag & Badge for Website Owners

Collect user data on your site

The HIP Badge does the following:

  • Enables you to transparently share control of your user data with your users
  • Can be a link for users to view and manage data you have collected on them

The HIP Tag does the following:

  • Can be configured to track the exact data points you care about, automatically or through user action
  • Writes your visitor information on the users’s HIP Profile (page URL, page meta keywords, custom data and more)

HIP Tag & Badge for Advertisers

Collect data on your ad

The HIP Tag is the main component of the HIP service. When used in your campaigns it does the following:

  • Lets consumers know you use HIP and support their right to control and manage data you track in your campaign
  • Tags consumers and stores your campaign tracking information in their HIP Profile automatically or through direct consumer interaction
  • HIP consumer data generated on one ad network is instantaneously accessible by campaigns on any other HIP partner ad network
  • Provides access to consumer.s HIP profile data (including 3rd party and consumer contributed data), allowing better ad selection or construction of dynamic ad content
  • Use previous campaign data to improve performance of future campaigns

The HIP Tag can be placed inside your ad and configured to be displayed in any way that suits your needs (it can even be hidden). It can also be configured to track the exact data points you care about, such as views, clicks, page URL and more.

The HIP Tag can be used to fully replace current methods of user tracking such as ad network tracking, cookies or server side profiles, or used as a complementary solution to such techniques.

 

FAQ

How do I know when a user interacts with my HIP Tag?

From our website you can search for all the users who have opted in to your content (either explicitly or automatically).

How can I access the user’s HIP Profile data?

To see data in the users. HIP Profile you can use the Permanent Search API. If you are only interested in data gathered via your site (through the HIP Tag) you can apply a filter to the API request to get just those values. Alternatively you can view all of the data available to you.

Can I just collect data and not show the HIP logo on every page?

Yes, you can choose not to show the HIP logo on every page by choosing the Do Not Show Anything option when configuring the HIP Tag. However, if you do this you are not giving your users a way to see the data you have added to their profile. If you choose to do this, HIP requires you provide a link on your official Privacy Policy page to the HIP Profile management page. To do this:

http://thehumaninformationproject.com/profile.html?sf=[YOUR WEBSITE DOMAIN]

For example this link would be the correct link for the website ebay.com:

http://thehumaninformationproject.com/profile.html?sf=ebay.com

NOTE: By not showing the HIP Badge you lose the benefit of showing that you are HIP Compliant and therefore proactively and transparently respecting their privacy.

What kind of data can I add to the users profile, and how can add custom defined data?

You can add any kind of data up to a maximum of 200 characters per page on your site. The data MUST be in human readable form so that your users can understand it. The widget is able to add the following data without any programming required: page URL and up to 3 HTML META keyword tags. To add additional custom data follow these steps:

  1. Select Yes in the Populate Custom Data section in the Get HIP Tag interface (above)
  2. Paste your HIP Tag into your page
  3. BEFORE the tag you can create a Javascript variable named HIPCustomData. This can be up to 200 characters long and you can separate keywords/phrases with commas.

For example, to have the tag populate the users HIP Profile with 3 separate values of “Sports”, “Fishing” and “Tennis” you could do:

<script type="text/javascript">

    var HIPCustomData = 'Sports,Tennis,Fishing';

</script>
//PASTE HIP TAG CODE HERE

What kind of keywords would best benefit my users and my site?

Keyword accuracy is important, because as users spend time on your site, you can use your keywords to bring more and more relevant content to them. So keep it simple and relevant.

For example, if you are showing a user a page about health you can have keywords such as vitamins, exercise, vegetables and so on. Or you can just put in your company or product names.

Think of using custom keywords as you would cookies… you can store data on a user’s HIP profile that you will be able to use when they return.

Where is the data stored?

The data is stored in the user’s HIP Profile. HIP Profiles live on the user’s local device (desktop, smartphone, tablet, etc). It is NOT stored on any servers of the Human Information Project, and likewise it is forbidden for HIP clients/partners to attempt to store it on their servers.

What makes up the number shown on the HIP Tag?

The number shown is the sum of users who have opted into the current page. Much the same as you would see a Facebook ‘Like’ Button.

READ

HIP API

Collecting data is good, but using data is better.  The HIP API enables you to access and read a user’s HIP profile data when they arrive or return to your site or simply goes to another page in your site.

  • Use HIP data to pre-select content based on the user’s prior history or content preferences
    • Make content recommendations on your site
    • Provide a list of previously viewed content

Access HIP Data

To get access to the user’s HIP Profile data you must include our API JavaScript file somewhere in your page content, like so:

<script src="http://www.thehumaninformationproject.com/js/optinapi.js"
 type="text/javascript"></script>

Get HIP Data

Then you can access the data, like so:

var optinapi = new OptinAPI();
var args = {key: "optindata"};
optinapi.getItem(args, function(key, value){
     if(value === undefined){
	  alert("This user has no optin data.");
     }
     else{
	  alert("This user has the following optin data:" + value);
     }
});

Get Specific HIP Data

When fetching data the following arguments can be passed to filter it according to your needs:

  • limit – character limit of data to fetch. All data beyond the limit will be truncated. (default: all)
  • category- array of categories to filter by (e.g. Brands, Products, etc)  (default: all)
    • Possible values are: General Content, Companies/Brands, Account Related, Products, Login Data, Site Tracking, Visited Page, Ads, Keyword/Interest, Searches, Favorites, Purchases, Ratings, Preferences, Other…
    • NOTE: If you pass category not exactly matching one of the above types it will be defaulted to ‘Other’.
  • optin – return opted in values (default: true)
  • optout – return opted out values (default: true)
  • itemlimit – max number of optin/optout items to fetch
  • order – order of results to fetch. can be ‘new’ for most recent first, ‘old’ for oldest first (default: new)
  • types – array of types to filter by (e.g. Person, Movie, Places). Types List.
  • onlykeywords- results to only include the keyword phrases
    • NOTE: no meta data such as types, category
  • dtstart- results to includes only values added AFTER dtstart.
    • NOTE: dstart must be a JavaScript UNIX Timestamp format.
  • dtend- results to includes only values added BEFORE dtend.
    • NOTE: dend must be a JavaScript UNIX Timestamp format.
  • src – results to be filtered to data added by src destination, which is a website url of the form ‘www.somesite.com’
  • auto – results to be filtered between auto and non-auto added results. true means only results that were automatically added, false only results that were explicitly added (default: both)
  • search- a list of search terms to look for in the HIP Profile keywords. For example ['Fishing','Boating'] would return all results containing the text Fishing or Boating.
    • NOTE: it is an OR operator, not and AND operator.

Add/Update HIP Data

This example ADDS a new data metric to show user searched for “fishing”:

var optinapi = new OptinAPI();
var args = {key: "optindata", name: "Search", 
value: "fishing", window.location.href, [], null, true, 1};
optinapi.addItem(args, function(key, value){});

This example UPDATES an existing data metric to show user viewed current page (the timestamp will be updated):

var optinapi = new OptinAPI();
var args = {key: "optindata", name: "Page Viewed", 
value: window.location.href, window.location.href, [], null, true, 1};
optinapi.updateItem(args, function(key, value){});

 

Examples

Here are some working examples. To see example in action it helps to have some optin/optout data defined for yourself, otherwise you won’t see any data in the examples. To do this add a few optin values from our home page first.

Example 1 – Full Data (Run Example)

This example simply retrieves all the optin/optout data of the user.

Example 2 – Limit Data (Run Example)

This example truncates the data after 500 characters.

Example 3 – Category Filter (Run Example)

This example returns only user data for the company/brand category.

Example 4 – Optins Only (Run Example)

This example returns optins only, not optouts.

Example 5 – Types Filter (Run Example)

This example returns optins/optouts of the type “Person” only.

Example 6 – Keywords Only (Run Example)

This example returns optins/optouts but only the keywords, no meta information such as type or category.

Example 7 – Amazon Products (Run Example)

This example does the following:

  • Queries the users optin data for keywords only and takes the first 10 values.
  • Passes the 10 keywords/phrases to a web server which reads them in and queries Amazon.com for products matching the phrases. The web server then returns the product information to the page.
  • Products are loaded into a JQuery slider for display.

Example 8 – Oldest First (Run Example)

This example returns optins/optouts in reverse order (showing values from oldest to newest).

Example 9 – Item Limit (Run Example)

This example returns optins/optouts but only 5 items maximum.

Example 10 – Keyword Filter (Run Example)

This example returns data filtered by a list of keywords.

Example 11 – Date Filter (Run Example)

This example returns data within a date range.

Example 12 – Auto Add Filter (Run Example)

This example returns data where the user explicitly added the optin (not those where it was gathered automatically).

Example 13 – Source Filter (Run Example)

This example returns filtered data by source origin. For example you view all HIP data gathered by your site, or by any specific site you choose.