Activities

Export workspace activities

Exports a workspace’s activity log over a date window as a downloadable file. The window is from/to (inclusive, YYYY-MM-DD); it defaults to the last 30 days and is capped at 366 days. The same type (repeatable) and actor filters as the feed apply. format is csv (default) or json. Each activity is a flat row: timestamp, the type split into object/action, the actor, and the acted-on object’s id and label, oldest first. At most 100,000 rows are returned (the oldest in the window); a truncated export sets the X-Export-Truncated response header.

GET

workspaces

{workspaceId}

activities

export

Export workspace activities

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/activities/export

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/activities/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workspaces/{workspaceId}/activities/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces/{workspaceId}/activities/export"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceId}/activities/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

Path Parameters

workspaceId

string<uuid>

required

Workspace identifier.

Query Parameters

actor

string<uuid>

Account id whose activities to keep. Omit for any actor.

type

string[]

Keep only these activity types (e.g. document.created). Repeat the type parameter for several; omit for no type constraint.

The type of activity performed in a workspace, for audit logging.

Corresponds to the ACTIVITY_TYPE PostgreSQL enum and categorizes the activities that occur within workspaces for a comprehensive audit trail.

Allowed value: "workspace.created"

from

string<date>

First day of the range (inclusive), YYYY-MM-DD. Defaults so the range spans the last DEFAULT_WINDOW_DAYS days through to.

string<date>

Last day of the range (inclusive), YYYY-MM-DD. Defaults to today (UTC).

format

Output format; defaults to csv.

Allowed value: "csv"

Response

The exported activity log.

Export workspace activities

curl --request GET \
  --url https://api.example.com/workspaces/{workspaceId}/activities/export

const options = {method: 'GET'};

fetch('https://api.example.com/workspaces/{workspaceId}/activities/export', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/workspaces/{workspaceId}/activities/export",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/workspaces/{workspaceId}/activities/export"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/workspaces/{workspaceId}/activities/export")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

{
  "message": "<string>",
  "name": "<string>"
}

API Reference

Endpoints

Export workspace activities

Path Parameters

Query Parameters

Response