How To: Use the Data Export Service API Explorer

Document created by mathews8 on Jan 8, 2015Last modified by Ekaterina Rudskaya on Jun 13, 2020
Version 6Show Document
  • View in full screen mode

The Data Export Service (DES) is a powerful way to access and export the analytics data from your community introduced in Jive 7.0 and Cloud Fall (2013). It allows you to access user activity data above and beyond what is available in Cloud Analytics or Community Manager Reports (CMR). The DES includes its own API which can be used to access the data programmatically and the DES Explorer which provides access directly from the community UI. Here you find details on using the DES Explorer – the user interface for data export.

About the DES Explorer

Besides the DES API which is a more technical way the community analytics data, we provide the DES Explorer as a more user-friendly interface. The DES 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.

The DES Explorer in its current form has been introduced with Jive Cloud 2019.2.3 release. The previous version that has been available as API Explorer (for PHX customers) or API Explorer (for AMS customers) are outdated and will be dismantled.

You can't expect the data you retrieve from the DES to match up with Cloud Analytics, CMR, 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 (GMT) 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.

For the information about the DES API and how to use it, refer to Using the V2 Jive Data Export Service (Analytics) and Analytics - Developer Resources.



  • Jive community (either Cloud, Hosted, or On-Premise) that uses Cloud Analytics
  • A user account with the Manage System, Manage Community, or Full Access permissions

Note that you do not need a client ID and secret to access the DES Explorer.



  • Maximum rows returned in a CSV are limited to 10,000. If you were calling for all the data to be returned in the query, use pagination instead to get the additional data.
  • Only files less than 180 MB can be downloaded from the Historical CSVs tab. Downloading larger files fails.
  • Exporting data with the DES Explorer is subject to the Jive Analytics Data Retention Policy. For more information, see Update to our Jive Analytics Data Retention Policy.




Using the DES Explorer

If you have sufficient access right, you can access the DES Explorer directly from your community.


How to access the DES Explorer

  1. Login to the community.
  2. Go to Your avatar > Analytics Export.

This opens the DES Explorer page which looks likes this:

From this, you can:

  • 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. The table below contains a breakdown of what the different filters mean and how you can use them.


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 download a CSV containing the events which are taken on places. For example, ACTIVITY_VIEW_SOCIALGROUP and ACTIVITY_MODIFY_SOCIALGROUP will be in the place CSV.
  • Clicking Download Activity CSV will download a CSV containing the events which do not fall into categories of content, user, or place. Activities like interactions with tags, searches, or custom content types from plugins fall under this category. Here are some examples: ACTIVITY_ACCLAIM_TAG, ACTIVITY_CONTENT_OR_PLACES_SEARCH, ACTIVITY_VIEW_EVENT, ACTIVITY_SPOTLIGHT_SEARCH.

And to understand what's in the CSVs, refer to V2 Data Export Service CSV Output Fields or to the Default CSV output fields in the Jive Cloud Analytics Community Manager Guide.


Table 1. Activity filters for the DES Explorer

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.

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



When trying to count particular activities (like creates, user logins, etc.).
ActivityTimeAll activities within a particular date range. This filter is required and cannot be removed.

Example: 05/28/2020 - 06/16/2020

  • Short date ranges (less than 3 months) when checking how the filter works.
  • Full date ranges when downloading activities with the filter applied.
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.


Example: 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 or Views)

When ActorActionObject 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.


Example: Name = "ANONYMOUS" or Profile.Department = "HR"

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 is a whole lot 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, or any other available type)
    Example: ObjectType = "document"
  • AuthorID: For activities around all content written by a particular author (grabbed from the Admin Console)
    Example: AuthorID = "1101"
  • FileName: For activities around a particular piece of content
    Example: 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.

Example: 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.

Example: Name = "My Plans & Services"

When trying to figure out views of the overview page in a place.
WebAll activities with specific web-related parameters, such as 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

Example: 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.


How to download CSVs

Once you update the filter, you can go to downloading the full spreadsheet. Gathering and filtering the data over large time periods make take a lot of time and result in timeouts when you try to download a CSV. So, you should follow these steps to avoid complications:

  1. Check the filter you've specified over a short period (less than 3 months) to make sure you get the data you need: Set the ActivityTime filter and click Preview.
  2. If the filter works for you, change the ActivityTime filter to the required period and click one of the Download CSV buttons.
    • If possible, the download will start once you specify where to save the file.
    • For large complex queries, you'll see a message like this:

      In this case, check the Historical CSV tab a bit later and download the CSV. The file link stays available on this tab for 2 days.

Related links