System logs

Use these methods to get the system log listing the actions made by Back Office users.

GET[host]/api/v2/logs/messages

Get a list of system logs

GET[host]/api/v2/logs/messages/{messageId}

Get system log details

Get a list of system logs

Use this method to obtain a list of records about Back Office users’ actions added to the system log.

Request

Header parameters:

  • Authorization: Bearer <token>

GET[host]/api/v2/logs/messages

curl --location --request GET 'https://host.name/api/v2/logs/messages?limit=10&offset=0' \
--header 'accept-language: <string>' \
--header 'Authorization: Bearer <token>'

Response

A response contains an array of System Log objects providing information about the records added to the system log.


Get system log details

Use this method to obtain detailed information about a specific record added to the system log.

Request

Header parameters:

  • Authorization: Bearer <token>

Path parameters:

messageId required

The record identifier.

GET[host]/api/v2/logs/messages/{messageId}

curl --location --request GET 'https://host.name/api/v2/logs/messages/:messageId' \
--header 'Authorization: Bearer <token>'

Response

A response contains a System Log object providing information about the specified record.