The raw data that powers Guru's Analytics Dashboard is available for export.
API Endpoint
GET /v1/teams/{teamId}/analytics?fromDate=&toDate=
URL Parameters
teamIdthe ID of the Team
Query Parameters
All query parameters are optional.
fromDateindicates the request should return all events with a date greater than or equal to this datetoDateindicates 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 - timezone is required for all formats
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%3A30%3A00%2B00%3A00
Sample Response
The response will contain an array of event objects. Fields include...
eventTypestring value indicating the type of eventeventDatethe date the event occurred, in ISO-8601 formatuseremail address of the user performing the eventpropertiesmap of key-value pairs. Values vary depending on the event type. The most common property iscardIdand 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" : "gary.t.goat@getguru.com",
"eventDate" : "2016-01-20T03:10:11.351+0000",
"properties" : {
"cardId" : "yyyyyyyy-yyyy-yyyy-yyyy-yyyyyyyyyyyy"
}
},
...
]
Comments
0 comments
Please sign in to leave a comment.