How to track textual input with Google Analytics

This week an analytics ninja showed me how to use Google Analytics to track the values entered into a text field. It comes down to sending a dummy page name to Google Analytics, containing the value entered into the field. Google Analytics faithfully records a “page view” for that value, which you can then see in the analytics reports in the same way that you can see any other page view. Magic.

For example, let’s say you have a search box on a documentation page, allowing readers to search a subset of the documentation.  It would be nice to track the most popular search terms entered into that field, as an indication of what most readers are interested in. If people are searching for something that is already documented, you might consider restructuring the documentation to give more prominence to that topic. And how about the terms that people enter into the search box without finding a match? The unmatched terms might indicate a gap in the documentation, or even give a clue to functionality that would be a popular addition to the product itself.

It turns out that you can track input values via Google Analytics. The trick is to make a special call to Google Analytics, triggered when the input field loses focus (onblur).

<input onblur="ga('send', 'pageview', 'my-page-name?myParam=' + this.value);" />

The above ga call sends a customised page view to Google Analytics, passing a made-up page name that you can track separately from the page on which the input field occurs. The made-up page name is a concatenation of a string ('my-page-name?myParam=') plus the value typed into the input field (this.value).

The string my-page-name can contain any value you like. It’s handy to use the title of the page on which the input box occurs, because then you can see all the page views in the same area of Google Analytics.

Similarly, the part that contains the input text can have any structure you like. For example, if the page is called “Overview” and the input field is a search box, the Google Analytics call could look like this:

<input onblur="ga('send', 'pageview', 'overview?searchText=' + this.value);" />

This blog post assumes you have already set up Google Analytics for your site. See the Google Analytics setup guide. The Google Analytics documentation on page tracking describes the syntax of the above “ga” call, part of “analytics.js”.

Follow-up on yesterday’s talk about API technical writing

Yesterday I was privileged and delighted to speak at a meeting of the STC Silicon Valley Chapter in Santa Clara. Thanks so much to Tom Johnson and David Hovey for organising the meeting, and thank you too to all the attendees. It was a lovely experience, with a warm, enthusiastic and inspiring audience. This post includes some links for people who’d like to continue playing with the APIs we saw last night and delving deeper into the world of API documentation.

The presentation is on SlideShare: API Technical Writing: What, Why and How. (Note that last night’s presentation didn’t include slide 51.) The slides include a number of links to further information.

The presentation is a technical writer’s introduction to APIs (Application Programming Interfaces) and to the world of API documentation. I hope it’s useful to writers who’ve had very little exposure to APIs, as well as to those who’ve played with APIs a bit and want to learn about the life of an API technical writer.

Overview

Here’s a summary of the presentation:

  • Introduction to the role of API technical writer.
  • Overview of the types of developer products we may be asked to document, including APIs (application programming interfaces), SDKs (software development kits), and other developer frameworks.
  • What an API is and who uses them.
  • Examples of APIs that are easy to play with: Flickr, Google Maps JavaScript API
  • Types of API (including Web APIs like REST or SOAP, and library-based APIs like JavaScript or Java classes).
  • A day in the life of an API technical writer—what we do, in detail.
  • Examples of good and popular API documentation.
  • The components of API documentation.
  • Useful tools.
  • How to become an API tech writer—tips on getting started.

Demo of the Flickr API

During the session, I did a live demo of the Flickr API. If you’d like to play with this API yourself, take a look at the Flickr Developer Guide (and later the Flickr API reference documentation). You’ll need a Flickr API key, which is quick and easy to get. Slide 23 in my presentation shows the URL for a simple request to the Flickr API.

Demo of the Google Maps JavaScript API

My second demo showed an interactive Google map, embedded into a web page with just a few lines of HTML, CSS and JavaScript. I used the Google Maps JavaScript API. If you’d like to try it yourself, follow the getting started guide in Google’s documentation. You’re welcome to start by copying my code. It’s on Bitbucket: HelloMaps.HTML. That code is what you’ll find on slide 28 in the presentation.

More links

There are more links to follow in the presentation itself: API Technical Writing: What, Why and How. I hope you enjoy playing with some APIs and learning about the life of an API technical writer!

Talk about API technical writing in Silicon Valley next Monday

I’ll be speaking at the meeting of the STC Silicon Valley Chapter in Santa Clara on Monday 25th August. Thanks to Tom Johnson for organising this get-together! I’m excited to meet the Silicon Valley writers. 

The talk is titled, “API Technical Writing: What, Why, and How“. The meeting announcement has the details.

Have you ever wondered what API technical writers do, and how they go about it? Perhaps you’d like to move into developer-focused documentation yourself, and need some tips on getting started.

Join us to discuss what an API is and poke some easy-to-use APIs that you can play with later yourself. Examine examples of API documentation, pick up a few useful tools, and grab some ideas on getting started in this field. It’s an exciting and rewarding area of technical communication.

Date and time:

August 25th, at 6pm for socialising. The talk starts at around 7pm.

Location: 

IHOP Restaurant
4200 Great America Parkway
Santa Clara, CA 95054-1210
408-980 8887

Lunch-time talk on API technical writing

I’ll be speaking at the lunchtime meeting of the Sydney CBD Technical Writers’ Group on Wednesday 6th August. This group is led by Bede Sunter on behalf of the Australian Society for Technical Communication NSW. The session is free of charge, and open to all. You’re invited! (Please bring your own lunch.)

The talk is titled, “API Technical Writing: What, Why, and How“.

Have you ever wondered what API technical writers do, and how they go about it? Perhaps you’d like to move into developer-focused documentation yourself, and need some tips on getting started.

Join us to discuss what an API is and poke some easy-to-use APIs that you can play with later yourself. Examine examples of API documentation, pick up a few useful tools, and grab some ideas on getting started in this field. It’s an exciting and rewarding area of technical communication.

Date and time: Wednesday 6 August, from 12:30 to 1:30.

Location: 

Level 21, HSBC Building
580 George Street – close to Town Hall Station
Sydney, Australia
Map: http://goo.gl/maps/7UdRH
Offices of TP3 Group
Ask at reception on level 21 for the room number

RSVP: Please add a comment to this page if you’re coming, so that we know how many people to expect over and above the usual crowd. :)

Hobbies and pastimes of technical writers everywhere

Hallo fellow techcomm folks! Do you have a hobby?

Mine is fairly pedestrian. I like to go walking in the bush. It blows away the cobwebs. Well, actually, I often have to blow away the cobwebs myself. They festoon the pathways in the early morning. It’s best to keep your mouth closed when strolling in the Australian bush, or you’ll find yourself spitting spiders.

Hobbies of technical writers

Sometimes a bird pops out and does something interesting, and I blog about it.

Of a dark winter’s eve I can perchance be found tickling the ivories. Perhaps significantly, other members of the household are usually to be found in the furthest corners of the house.

So fess up

What do you get up to when the pleasures of the pen pall? (Aside from avoiding sentences like that.)

For years I had a Calvin and Hobbes cartoon pasted above my desk. It showed Calvin’s father with a mangled bicycle, obviously the result of a bad stack. The caption read: “The secret to enjoying your job is to have a hobby that’s even worse.”

Follow

Get every new post delivered to your Inbox.

Join 1,470 other followers

%d bloggers like this: