Get Web API Log

This method will retrieve a list of Web API Logs. All events that get logged are related to a change of a license key or data object, eg. when license key gets activated or when a property of data object changes. More details about the method that was called are specified in the State field. You can read more about it here. These logs contain minimal information but are guaranteed to be preserved. To get more information, especially about changes not tracked in this log, please check out the Object Log. Note, it's possible to restrict access to this method so that it can be used inside a client application, more about this in remarks.


This method is accessed by

Parameter Description Remarks
ProductId The product id that we should filter on. optional
Key The key string that we should filter on. optional, but requires ProductId to be specified.
MachineCode The machine code to filter on. Requires the entire machine code to be specified. Case sensitive. optional
FriendlyName The friendly name to filter on. "Contains" operation is used, i.e. you do not need to specify the entire friendly name. Case insensitive. optional
States The list of integer values representing the state that you want to filter on. This allows you to extract logs related to a certain event. For example, if you want to see all CreateKey request, you can set this parameter to [3010]. If you need to filter on multiple events, you can add them to the list as follows: [3010,2010]. You can read more about the different states here. optional
Limit Specifies how many events should be returned. default is 10 and at most 1000
StartingAfter Works as a cursor (for pagination). If the last element had the id=125, then setting this to 125 will return all events coming after 125. optional
EndingBefore Works as a cursor (for pagination). If the last element had the id=125, then setting this to 125 will return all events coming before 125. optional
OrderBy Allows you to order the data based on one of the fields in the Web API Log Objects. By default, it will order in "ascending" mode. To change that, you can append "descending" to the field. For example, to order by Id in a descending order, you can set this variable to Id descending. optional (depricated)
AnomalyClassification If enabled, the result will contain information about whether a certain request is anomalous. You can read more about this feature here. optional, false by default.
v Method version. optional. by default, it's 1.


Parameter Description Remarks
Logs A list of Web API Log Objects. If AnomalyClassification is set to true, a list of Web API Log Objects (extended) will be returned instead. returned if no errors are thrown
Result This is either 0(=success) or 1(=error). always returned
Message The message that provides additional information about the result. If it's a successful result, null will be returned. Otherwise, in case of an error, a short message will be returned describing the error. always returned.

Example results



  • If you set KeyLock=-1 when creating the access token, this method will require the product id together with the license key string. This can be used to retrieve logs inside a client application without exposing logs of other license keys.


Access denied.
The input parameters were incorrect.
An error occured.