Audit log

Monite keeps an audit log of all API calls made to entity resources, as well as the responses returned. Entity administrators and auditors can use the audit trail to understand which business objects were accessed, when, and by whom.

Access the audit trail

To get the audit log, call GET /audit_logs. The request can be authenticated using either a partner access token or an entity user token. A partner access token provides access to the complete audit trail of that entity's business logic objects, whereas an entity user token provides access only to the events triggered by that entity user.

curl -X 'https://api.sandbox.monite.com/v1/audit_logs' \
     -H 'X-Monite-Version: 2024-01-31' \
     -H 'X-Monite-Entity-Id: ENTITY_ID' \
     -H 'Authorization: Bearer ACCESS_TOKEN'

Parameters

You can filter the returned audit log events by using the following query parameters. If multiple filter parameters are provided, the filters are combined using logical AND.

📘

All parameters are optional.

Examples

• Get events logged since June 1, 2023 UTC: GET /audit_logs?timestamp__gte=2023-06-01T00:00:00Z

• Get events logged between June 1 and 5, 2023 UTC, inclusively: GET /audit_logs?timestamp__gte=2023-06-01T00:00:00Z&timestamp__lt=2023-06-06T00:00:00Z

• Get events related to the manual creation of payables: GET /audit_log?path__contains=/v1/payables&method=POST

Pagination

The GET /audit_logs endpoint supports pagination. The default page size is 100 entries but can be changed using the page_size query parameter (1..100).

To paginate through the audit log:

1. Send the initial GET request with the desired filters and page_size. For example: GET /audit_log?type=receivables&page_size=10

2. Examine the response and note down the next_pagination_token. This token can be used to access the next page of the audit log. If the next_pagination_token value is null, it means the last page was reached.

   JSON

   {
     "data": [
       {
         ...
       }
     ],
     "total_pages": 54,
     "total_logs": 532,
     "prev_pagination_token": null,
     "next_pagination_token": "bGltaXQ9MiZmaXJzdF9vaWQ9MSZuZXh0X3Rva2VuPTQ="
   }
   

3. Process the data contained in the response as needed.

4. Call GET /audit_logs again with the pagination_token query parameter containing the next_pagination_token value from the last response:
   GET /audit_logs?pagination_token=bGltaXQ9MiZmaXJzdF9vaWQ9MSZuZXh0X3Rva2VuPTQ=
   Note: There is no need to provide the page_size and filter parameters in subsequent requests because they are encoded in the pagination token.

5. Repeat steps 2-4 until you reach the last page.

Audit log data

The data is returned in the JSON format.

{
  "data": [
    {
      // Sample log entry that corresponds to a request
      "id": "1e0870cb-368d-431f-bbae-545d9b1fa0e1",
      "timestamp": "2023-05-31T21:33:42.321Z",
      "entity_id": "e0c6e681-0080-4ec9-893a-8a4a061ab1dc",
      "entity_user_id": "6523a913-a666-463d-a120-177a98f49aaa",
      "type": "request",
      "parent_log_id": null,

      // Request data
      "path": "/v1/payment_terms",
      "method": "POST",
      "params": null,
      "content_type": "application/json",
      "body": {
        "name": "Net 30",
        "term_final": {
          "number_of_days": 30
        }
      },
      "headers": {
        "x-monite-version": "2024-01-31",
        ...
      },
      "status_code": 0
    },
    { ... more items ... }
  ],
  "total_pages": 54,
  "total_logs": 532,
  "prev_pagination_token": null,
  "next_pagination_token": "bGltaXQ9MiZmaXJzdF9vaWQ9MSZuZXh0X3Rva2VuPTQ="
}