List Analytics Data

API Endpoint

GET /v1/teams/{teamId}/analytics?fromDate=&toDate=

URL Parameters

teamId the ID of the Team

Query Parameters

All query parameters are optional.

fromDate indicates the request should return all events with a date greater than or equal to this date
toDate indicates the request should return all events with a date less than or equal to this date

The date value in the fromDate and toDate query parameters must be in one of the ISO-8601 formats...
yyyy-MM-ddZ (i.e. 2015-02-01+04:00)
yyyy-MM-ddTHH:mmZ (i.e. 2015-02-01T15:01+04:00)
yyyy-MM-ddTHH:mm:ssZ (i.e. 2015-02-01T15:01:30+04:00)
yyyy-MM-ddTHH:mm:ss.SSSZ (i.e. 2015-02-01T15:01:30.000+04:00)
NOTE - If you do not give a timezone in your request, it will default to+00:00.

Sample Request

To return all analytics events since January 1st, 2016 at 5:30am UTC, a fromDate of 2016-01-01T05:30:00+00:00 is specified. When URL encoding the query parameters, the full URL is as follows...

https://api.getguru.com/api/v1/teams/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/analytics?fromDate=2016-01-01T05:30:00+00:00

To return all analytics events between September 4th, 2020 and Septermber 7th, 2020 (including all events on the 7th), a fromDate of 2020-09-04T00:00:00 is specified and a toDate of 2020-09-08T00:00:00

https://api.getguru.com/api/v1/teams/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/analytics?fromDate=2020-09-04T00:00:00&toDate=2020-09-08T00:00:00

Sample Response

The response will contain an array of event objects. Fields include...

eventType string value indicating the type of event
eventDate the date the event occurred, in ISO-8601 format
user email address of the user performing the event
properties map of key-value pairs. Values vary depending on the event type. The most common property is cardId and is the ID of the card the event applies to

Results for these calls can be paged. See the Paging documentation for more information.

[
  {
    "type" : "fact-viewed",
    "user" : "[email protected]",
    "eventDate" : "2016-01-20T03:10:11.351+0000",
    "properties" : {
      "cardId" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
    }
  },
  ...
]

Analytics Event Types

Below is a list of event types that our API Analytics tracks:

card-created a new card as been published
card-comment-created a user has commented on a card
card-copied a user either copied the content within the card or clicked on the "Card Copied content" button while viewing a card
card-deleted a card has been archived
card-favoriteda user clicked the heart icon to add the card to "My Favorite Card" list
card-shared-to-team a user made a private card to a team shared card or created a new card which is team shared
card-updated a user made edits to a card
card-verified a user has verified a card
card-viewed a user clicked & viewed a card
card-unfavorited a user removed a card from their "My Favorite Card" list
search a user performed a type ahead search and click on one of the Top Title Matches or typed in the search bar to see the Search Results
board-created a user created a new folder within a Collection
board-updated a user edited an existing folder within a Collection
board-deleted a user deleted an existing folder within a Collection
board-viewed a user viewed an existing folder within a Collection
card-link-copied a user clicked on the "Card Copy link" button while viewing a card
card-file-link-viewed a user viewed a link to a file that is uploaded to a card and displayed in the card's file viewer
question-answered a user answered a question in the "Ask the Experts" feature
question-created a user created a question in the "Ask the Experts" feature
question-deleted a user deleted a question in the "Ask the Experts" feature
login a user logged into Guru