COcommpeak
Logs

Get all logs

Returns audit log entries created within a time range, so you can review configuration and data changes across your account.

When to use. See who changed what and when. To review the history of a single record, pass object_type and object_id together.

Parameters. from and till (both required) set the start and end of the time range. Optionally filter by user_id, or by object_type and object_id together. You can also set limit (between 1 and 500) and fields to choose which fields each entry returns.

Returns. { "logs": [ ... ] }, where each entry has an ID, creation timestamp, user ID, message, object type, and object ID.

get/{sub_domain}/api/logs

Request

  • Base URL
    https://api.commpeak.com/dialer
  • URL
    https://api.commpeak.com/dialer/{sub_domain}/api/logs
  • Auth
    API key in header Authorization

Path parameters

sub_domainstring required

Dialer Name (subdomain)

Query parameters

fromstring required

Return logs created on or after this date and time.

tillstring required

Return logs created on or before this date and time.

object_typestring nullable

Object type to filter by (required when object_id is set). Use PUT /logs to retrieve the full list of available object types.

object_idinteger nullable

ID of the related object to filter by (required when object_type is set).

user_idinteger nullable

Return only logs created by this user.

limitinteger nullable

Maximum number of entries to return.

fieldsstring nullable

Semicolon-separated list of fields each entry returns.

Response

Successful Response

Example response

{
  "logs": [
    {
      "created_at": "2020-01-02 11:55:18",
      "id": 140795,
      "message": "logged in <a href=\"/user/edit/id/276\" >user</a>",
      "object_id": 276,
      "object_type": "Model_DbTable_Users",
      "user_id": 276
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.