View

View information about event logs.

Note that this action will only retrieve the log entries for the active customer or accounts, if provided.

Tokens

This action requires the following tokens:

  • eventlog-view

Arguments

Required arguments are marked in bold, and optional arguments are marked in italics.

Argument Type Default Description
event String   Only show logs about this type of event, should be an event name
mindate DateTime   Only show events that happened on or after this date
maxdate DateTime   Only show events that happened on or before this date
user Hash   Only show events of this user
limit Integer 20 The maximum number of results to include in the output
offset Integer 0 The number of results to skip when outputting
orderfield String date

Defines the field to order the results by; can be any of the following:

  • date – Order by the date when the entry was created
order String asc Sort the results by the field given in orderfield in ascending or descending order, by using ‘asc‘ or ‘desc‘ respectively

Output

This action produces the following extra headers on success, besides the default headers:

Name Type Description
count Integer The total number of results that would be returned when pagination would be disabled

This action produces the following output on success:

An array containing zero or more elements, each one being an object containing the following fields:

Name Type Description
id Integer Numerical ID of this event log entry
date DateTime When the event happened that caused this log entry to be created
event

Event for which this log entry was created

The value of this field is an object containing the following fields:

Name Type Description
name String Event name
description String Description of this event
token Label If given, this token is required to create, delete or edit event hooks for this event
data JSON Data stored for this event log entry
account

If set, account for which this event was fired

The value of this field is an object containing the following fields:

Name Type Description
id Hash Account ID
name String Account name
user

If set, user for which this event was fired

The value of this field is an object containing the following fields:

Name Type Description
id Hash User ID
username String User name

Errors

This action will always return one of the default status codes.