Activity logs

This API is not available for self-service at the moment, and you will need to contact us if you are interested in using it.

List activity logs

This endpoint allows to list activity logs on a particular project and environment.

Records are returned sorted by createdAt date, in descending order (from most recent to least recent).

Pagination can be achieved by filtering on createdAt date.

get

/v1/project/{projectName}/environment/{environmentName}/activity-logs

Authorizations

Path parameters

environmentNamestring · min: 1required

The case sensitive environment name

projectNamestring · min: 1required

The case sensitive project name

Query parameters

limitinteger · min: 1 · max: 100 · default: 10

This specifies a limit on the number of objects to return, ranging between 1 and 100. Limit is set to 10 by default

userEmailstring · email

The user email

userIdinteger · min: 1

The user id

teamNamestring · min: 1

The team name

collectionNamestring · min: 1

The collection name (same as in the schema).

recordIdstring · min: 1

The record id

actionstring · enum

The action performed

Options: create, read, update, delete, action, search, filter, index, select, dashboard, workspace, export, createNote, openNote, deleteNote, createMessage, createApproval, approveApproval, rejectApproval, ignoreApprovalWarning, markApprovalAsFailed, startProcessingInboxTask, cancelInboxTask, autoCancelInboxTask, assignUserToInboxTask, unassignUserFromInboxTask, sendApprovalBackInReview

typestring · enum

The type of the activity log

Options: read, write

createdAt.eqstring · date-time

Value to filter by

createdAt.ltstring · date-time

Maximum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.ltestring · date-time

Minimum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtstring · date-time

Minimum value to filter by (exclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

createdAt.gtestring · date-time

Maximum value to filter by (inclusive). This filter supports date-time values in ISO 8601 format (YYYY-MM-DDTHH:MM), e.g., 2024-06-04T09:21:26.159Z.

Responses

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://public-api.forestadmin.com/v1/project/{projectName}/environment/{environmentName}/activity-logs' \
  --header 'Authorization: Bearer JWT'

200

429

4XX

5XX

200

{
  "hasMore": false,
  "parameters": {
    "projectName": "Forest",
    "environmentName": "Production",
    "limit": 10
  },
  "data": [
    {
      "object": "activityLog",
      "id": "rbCb98wCZ1y-_zv4wrXz",
      "type": "write",
      "action": "update",
      "label": "updated",
      "createdAt": "2024-03-14T15:09:26.535Z",
      "recordIds": [
        "42"
      ],
      "user": {
        "object": "user",
        "id": 1,
        "username": "alice",
        "email": "[e-mail]"
      },
      "environment": {
        "object": "environment",
        "name": "Production"
      },
      "collection": {
        "object": "collection",
        "name": "subscriptions"
      },
      "team": {
        "object": "team",
        "name": "Sales"
      }
    },
    {
      "object": "activityLog",
      "id": "fHCb9IXCZ1y_Pzv4wrXz",
      "type": "write",
      "action": "startProcessingInboxTask",
      "label": "assigned to",
      "createdAt": "2024-03-14T15:09:26.535Z",
      "recordIds": [
        "4242"
      ],
      "user": {
        "object": "user",
        "id": 2,
        "username": "bob",
        "email": "[e-mail]"
      },
      "environment": {
        "object": "environment",
        "name": "Production"
      },
      "collection": {
        "object": "collection",
        "name": "subscriptions"
      },
      "team": {
        "object": "team",
        "name": "Operations"
      },
      "inbox": {
        "object": "inbox",
        "name": "Ids check"
      }
    }
  ]
}

List of activity logs