How To: Use the Data Export Service API Explorer

Version 1

    Overview

    The Data Export Service is a powerful way to access analytics data introduced with Jive 7.0. It allows you to access user activity data above and beyond what is available in the Community Manager Reports. There is documentation available on the DES at Using the Jive Data Export (Analytics) Service | Jive Community, but these instructions provide a very technical overview using terms like CURL and JSON and things that aren't really comprehensible to the average business user. If you have a technical resource who can make sense of it, great! Fortunately, for the rest of us, we've created a more user-friendly interface call the the Data Export Service Analytics Explorer. The Analytics Explorer is a way to access the analytics information in CSV format through a configurable web interface. Once you have the CSV, you can import it to a BI tool or manipulate that data within Excel.

     

    Note that you can't expect the data you retrieve from the DES to match up with the Community Manager Reports or other analytics platforms (like Google Analytics or SiteCatalyst) because the methods and time spans for the data collection are different. As just one factor, the DES uses Greenwich Mean Time for its timezone (non-editable), and the CMRs use whatever timezone your community uses (or a rolling span). When you use data from the DES, make sure you only trend it against data from the DES so you can appropriately compare apples to apples.

     

    How to Access The Analytics Explorer

    Stolen in part from Using the Jive Data Export (Analytics) Service | Jive Community

     

    Inside your Community

    1. When logged in to Jive as a full access administrator, click your avatar in the top right, and select Add-ons.
    2. From the Add-ons tab, select Analytics Services > New Client.
    3. Enter the Client name. Make sure you use a descriptive name that will help you remember the system it's being used for.
    4. Click Generate Client ID & Secret.
    5. Copy and paste the information to where you can find it when you need it.

     

    At API Explorer

    • Go to API Explorer in your browser. Any modern browser should be supported, but Chrome works really well for me.
    • Enter the Client ID & Secret ID and click Login.
    • Now that you're in, you should get an ominous-looking page like this:
      api1.jpg
    • From this, you can see there are a few things you can do through the interface:
      • Logout
      • Change the date range
      • Apply activity filters
      • Preview and download analytics data

     

    How To Filter The Data

    At a high level, you'll be specifying a date range and a type of activity to filter. The activity filters are the various ways we can slice and dice the analytics data. Once you update these elements, you can click to Preview Data before downloading the full spreadsheet. What data set to download depends on what type of thing you're measuring the actions on:

     

    Clicking Download Content CSV  will download a csv containing the events which are taken on content objects. For example, ACTIVITY_CREATE_DOCUMENT will be in the content csv because the action object is a document, which is a type of content.

    Clicking Download User CSV will download a csv containing the events which are taken on user objects. For example, ACTIVITY_LOGIN_USER and ACTIVITY_VEW_USER events will both be in the user csv because the action object is a user.

    Clicking Download Place CSV will downalod a csv containing the events which are taken on places. For example, ACTIVITY_VIEW_SOCIALGRUOP and ACTIVITY_MODIFY_SOCIALGROUP will be in the place csv.

    The Download Activity CSV button downloads a csv containing the events which do not fall into categories of content, user, or place. Examples of this are interactions with tags, searches, or custom content types from plugins, etc. Here are some examples: ACTIVITY_ACCLAIM_TAG, ACTIVITY_CONTENT_OR_PLACES_SEARCH, ACTIVITY_VIEW_EVENT, ACTIVITY_SPOTLIGHT_SEARCH

     

    Here is a breakdown of what the different filters mean and how you can use them:

    Activity FilterDescriptionFormatWhen To Use
    ActionThese are the activities that a user can take in the community. By default, you see ALL actions taken during the time period.

    Grab action names from the EXAMPLE column under List of All Data Export Events at Using the Jive Data Export (Analytics) Service | Jive Community .

    SAMPLE: ACTIVITY_LOGIN_USER

    When trying to count particular activities (like creates, user logins, etc.).
    ActivityTimeAll activities at a particular timestamp.SAMPLE: 1403210186028This could be useful if you were debugging an issue and trying to determine exactly what happened at a particular time.
    ActivityTime.DateThis filter should be removed in an upcoming release.
    ActivityTime.HourThis filter should be removed in an upcoming release.
    ActorAll activities by a particular user.

    When Actor is selected, you can then filter by any profile field set up in your community to choose particular users. The profile fields available are specific to the community.

    SAMPLE: Name = "ANONYMOUS" or LastName = "Mathews"

    When trying to isolate activities by particular members or groups of members.
    ActorActionObjectAll activities performed upon a user (like Follows, Views, etc.)Same filters as Actor.When trying to figure who is viewing and connecting with other users.
    ContentActionObjectAll activities performed on a specific piece of content or content type.

    There a whole mess of filters available for this report, but ObjectType, AuthorID, and FileName seem to be the most useful.

    • ObjectType: For activities around all content of a particular type (Documents, Discussions, etc.)
      SAMPLE: ObjectType = "document"
    • AuthorID: For activities around all content written by a particular author (grabbed from the admin console)
      SAMPLE: AuthorID = "1101"
    • FileName: For activities around a particular piece of content
      SAMPLE: FileName = "Sample Document"
    When trying to determine new document creation, edits, etc. or activities on a particular piece of content or user's content.
    DestinationAll activities by all users on all content types in a particular place.

    When Destination is selected, you can then filter by a few fields. Name is probably the most clear and easy to use, so just enter the name of the place.

    SAMPLE: Name = "My Plans & Services"

    When trying to isolate activities within a place (Group, Space, Project, or Personal Content).
    DestinationActionObjectAll activities specifically on the place (like viewing the place overview page).

    Provides the same filters as Destination, so Name is your best bet.

    SAMPLE: Name = "My Plans & Services"

    When trying to figure out views of the overview page in a place.
    WebAll activities with a specific web-related parameters like browser or session ids.

    The following filters are supported for this report:

    1. SessionID
    2. ReferringSource
    3. ReferringUser
    4. AppVersion
    5. UserAgent
    6. AppSpecConnectionType
    7. AppID
    8. AppSpecDeviceVersion
    9. AppSpecRequestOrigin

    SAMPLE: UserAgent = "Mozilla"

    For the average business user, the useful report inside of here is the user agent to figure out what browser visitors are using.

     

    Thanks to Dirk McNealy for his patience and assistance in putting this post together.