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.

GEThttps://public-api.forestadmin.com/v1/project/{projectName}/environment/{environmentName}/activity-logs

Authorization

bearerAuth

Path parameters

environmentName*string

The case sensitive environment name

projectName*string

The case sensitive project name

Query parameters

Response

2004294XX5XX

List of activity logs

Body

application/json

hasMore*boolean

Whether or not there are more elements available after this set. If false, this set comprises the end of the list.

data*array of object

parameters*object

The parameters used to fetch the activity logs

Request

JavaScriptCurlPython

const response = await fetch('https://public-api.forestadmin.com/v1/project/{projectName}/environment/{environmentName}/activity-logs', {
    method: 'GET',
    headers: {
      "Authorization": "Bearer JWT"
    },
});
const data = await response.json();

Response

2004294XX5XX

{
  "hasMore": false,
  "data": [
    {
      "object": "activityLog",
      "id": "text",
      "type": "read",
      "action": "create",
      "label": "text",
      "recordIds": [
        "text"
      ],
      "createdAt": "2024-09-08T02:50:51.275Z",
      "user": {
        "object": "user",
        "email": "[e-mail]",
        "username": "text"
      },
      "environment": {
        "object": "environment",
        "name": "text"
      },
      "collection": {
        "object": "collection",
        "name": "text"
      },
      "inbox": {
        "object": "inbox",
        "name": "text"
      },
      "team": {
        "object": "team",
        "name": "text"
      }
    }
  ],
  "parameters": {
    "environmentName": "text",
    "projectName": "text",
    "userEmail": "[e-mail]",
    "teamName": "text",
    "collectionName": "text",
    "recordId": "text",
    "action": "create",
    "type": "read",
    "createdAt.eq": "2024-09-08T02:50:51.275Z",
    "createdAt.lt": "2024-09-08T02:50:51.275Z",
    "createdAt.lte": "2024-09-08T02:50:51.275Z",
    "createdAt.gt": "2024-09-08T02:50:51.275Z",
    "createdAt.gte": "2024-09-08T02:50:51.275Z"
  }
}