Activities

Searching or filtering on activity logs

Activity logs can quickly become huge due to the number of actions performed. To properly filter data during a GET /activities, the Whispir API provides very neat filtering options.

All filter options are to be passed in as URL query parameters.

Search criteria

action

/activities?action=Map

module

/activities?module=Message

user

/activities?user=james

workspace

/activities?workspace=Whispir.

See also Restricting activities to a single workspace.

status

/activities?status=Successful

description

/activities?description=Imported

Start time

The date and time to start searching from in the format: dd/mm/yyyy hh:mm. This will search on the ‘time’ field.

/activities?startTime=01/01/2019%2000:00

End time

The date and time to search to in the format: dd/mm/yyyy hh:mm

/activities?endTime=01/01/2019%2000:00


Note: The API currently results in a 404 Not Found response when there are no activities in the log for a given search criteria. This should not be considered a failed response but rather as No Data Found.


  • JSON
  • XML
HTTP 1.1 GET https://api.<region>.whispir.com/activities?apikey=[your_api_key]&field=value
Authorization: Basic asdf98nf89asdvasd2r398h8sdf
x-api-key: your_api_key