API Reference

Game.getUserLog

Get a list of game activity for a user.



Syntax

array game.getUserLog ( int vhostid, int userid = 0, int start = 0, int limit = 50, int pointsonly = 0, array filters = array(), array options = array() )

Arguments

NameTypeRequiredDefault valueDescription
vhostidintRequirednoneThe vhost id.
useridintOptional0Obsolete - moved into options
startintOptional0If you specify an offset, you will be the media items starting at this position.
limitintOptional50The total number of files you want to receive.
pointsonlyintOptional0Obsolete - moved into options
filtersarrayOptionalarray()You can specify the filter parameters here as an array. Details in table below.
optionsarrayOptionalarray()You can specify the options parameters here as an array. Details in table below.

Filters

Filters allow you to restrict the data that is returned. Below is a list of valid filters.

NameTypeDescriptionDefault Values
startTimeSTRINGThis attribute filters by the action date. No actions created before the startTime will be returned. Usually you should use the 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.empty
endTimeSTRINGThis attribute filters by the action date. No actions created past the endTime will be returned. Usually you should use 'YYYY-MM-DD HH:MM:SS' format, but using the following values will also work: 'yesterday', 'midnight', 'today', 'now', 'noon', or 'tomorrow'.empty
userIdINTThe user you request to filter actions by, all users without this filter (with the appropriate permissions, otherwise the logged in user actionslogged in user or all based on permissions
actionidINTThe specific action to filter onempty
typeINTFilter on the Type associated with the game's rule.empty

Options

Below you will find a list and description of all of the available options you can provide to the service.

NameTypeDescriptionDefault Values
pointsOnlyBOOLThis will return only actions where the user earned points
notSeenBOOLThis will return only actions where the actions have not been marked as seen.
countOnlyBOOLThis will return only total count of the matchin results;

Fields

Below you will find a list and description of all of the available fields to have returned with our game.getUserLog service.

NameDescription
idThe entry id
seenIf the entry has been marked as seen or not 0 for not seen, 1 for seen.
iconThe badge or icon associated with this event.
infoAdditional information about the event.
actionIdThe action triggered by this event
logTextCustom text configured in the game settings, which can make use of our template system.
uidThe user id associated with the action.
actionTimeThe time the action occurred
pointsearnedHow many points the user earned or lost during this action .
subjectidThe Id of the object involved in the action, can be a user id, a media id, a group, channel, or collectionn.
firstnameThe first name of the user associated with the action
lastnameThe last name of the user associated with the action.
userThe user name associated with the action

Sample Response

Code examples

0 comments

Be the first to comment on getUserLog.

Add a Comment

  • captcha