Export activity logs

POST

/api/v1/activity/export

const url = 'http://localhost:3000/api/v1/activity/export';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"organizationId":"example","userId":"example","startDate":"example","endDate":"example","activityTypes":["example"],"format":"csv","maxRecords":10000}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url http://localhost:3000/api/v1/activity/export \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "organizationId": "example", "userId": "example", "startDate": "example", "endDate": "example", "activityTypes": [ "example" ], "format": "csv", "maxRecords": 10000 }'

Exports activity logs to CSV or JSON format. Requires Super Admin privileges.

Authorizations

api-key
bearer

Request Body^required

application/json

object

organizationId

Filter by organization ID

string

userId

Filter by user ID

string

startDate

Filter by start date

string

endDate

Filter by end date

string

activityTypes

Filter by activity types

Array<string>

format

Export format

string

default: csv

Allowed values: csv json

maxRecords

Maximum number of records

number

default: 10000

Responses

200

Activity exported successfully

401

Unauthorized

403

Forbidden - Super Admin required

Export activity logs

Authorizations

Request Body required

Responses

200

401

403

Request Body^required