Get Activity Logs

POST /v2/activities/get

Get Activity Logs

cURL

curl --request POST \
  --url https://api.velt.dev/v2/activities/get \
  --header 'Content-Type: application/json' \
  --header 'x-velt-api-key: <x-velt-api-key>' \
  --header 'x-velt-auth-token: <x-velt-auth-token>' \
  --data '
{
  "data": {
    "organizationId": "<string>",
    "documentId": "<string>",
    "targetEntityId": "<string>",
    "featureTypes": [
      "<string>"
    ],
    "actionTypes": [
      "<string>"
    ],
    "userId": "<string>",
    "activityIds": [
      "<string>"
    ],
    "order": "<string>",
    "pageSize": 123,
    "pageToken": "<string>"
  }
}
'

import requests

url = "https://api.velt.dev/v2/activities/get"

payload = { "data": {
        "organizationId": "<string>",
        "documentId": "<string>",
        "targetEntityId": "<string>",
        "featureTypes": ["<string>"],
        "actionTypes": ["<string>"],
        "userId": "<string>",
        "activityIds": ["<string>"],
        "order": "<string>",
        "pageSize": 123,
        "pageToken": "<string>"
    } }
headers = {
    "x-velt-api-key": "<x-velt-api-key>",
    "x-velt-auth-token": "<x-velt-auth-token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-velt-api-key': '<x-velt-api-key>',
    'x-velt-auth-token': '<x-velt-auth-token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    data: {
      organizationId: '<string>',
      documentId: '<string>',
      targetEntityId: '<string>',
      featureTypes: ['<string>'],
      actionTypes: ['<string>'],
      userId: '<string>',
      activityIds: ['<string>'],
      order: '<string>',
      pageSize: 123,
      pageToken: '<string>'
    }
  })
};

fetch('https://api.velt.dev/v2/activities/get', 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.velt.dev/v2/activities/get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'data' => [
        'organizationId' => '<string>',
        'documentId' => '<string>',
        'targetEntityId' => '<string>',
        'featureTypes' => [
                '<string>'
        ],
        'actionTypes' => [
                '<string>'
        ],
        'userId' => '<string>',
        'activityIds' => [
                '<string>'
        ],
        'order' => '<string>',
        'pageSize' => 123,
        'pageToken' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-velt-api-key: <x-velt-api-key>",
    "x-velt-auth-token: <x-velt-auth-token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.velt.dev/v2/activities/get"

	payload := strings.NewReader("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"targetEntityId\": \"<string>\",\n    \"featureTypes\": [\n      \"<string>\"\n    ],\n    \"actionTypes\": [\n      \"<string>\"\n    ],\n    \"userId\": \"<string>\",\n    \"activityIds\": [\n      \"<string>\"\n    ],\n    \"order\": \"<string>\",\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-velt-api-key", "<x-velt-api-key>")
	req.Header.Add("x-velt-auth-token", "<x-velt-auth-token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.velt.dev/v2/activities/get")
  .header("x-velt-api-key", "<x-velt-api-key>")
  .header("x-velt-auth-token", "<x-velt-auth-token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"targetEntityId\": \"<string>\",\n    \"featureTypes\": [\n      \"<string>\"\n    ],\n    \"actionTypes\": [\n      \"<string>\"\n    ],\n    \"userId\": \"<string>\",\n    \"activityIds\": [\n      \"<string>\"\n    ],\n    \"order\": \"<string>\",\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.velt.dev/v2/activities/get")

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

request = Net::HTTP::Post.new(url)
request["x-velt-api-key"] = '<x-velt-api-key>'
request["x-velt-auth-token"] = '<x-velt-auth-token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"organizationId\": \"<string>\",\n    \"documentId\": \"<string>\",\n    \"targetEntityId\": \"<string>\",\n    \"featureTypes\": [\n      \"<string>\"\n    ],\n    \"actionTypes\": [\n      \"<string>\"\n    ],\n    \"userId\": \"<string>\",\n    \"activityIds\": [\n      \"<string>\"\n    ],\n    \"order\": \"<string>\",\n    \"pageSize\": 123,\n    \"pageToken\": \"<string>\"\n  }\n}"

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

{
  "result": {
    "status": "success",
    "message": "Activity(s) retrieved successfully.",
    "data": [
      {
        "id": "activity-001",
        "featureType": "comment",
        "actionType": "comment.add",
        "actionUser": {
          "userId": "user-1",
          "email": "[e-mail]",
          "name": "User Name"
        },
        "targetEntityId": "annotation-789",
        "displayMessageTemplate": "{{user}} added a comment",
        "displayMessageTemplateData": {
          "user": {
            "userId": "user-1",
            "name": "User Name"
          }
        },
        "metadata": {
          "apiKey": "yourApiKey",
          "documentId": "doc-456",
          "organizationId": "org-123"
        },
        "timestamp": 1722409519944
      }
    ],
    "pageToken": "nextPageToken"
  }
}

Use this API to retrieve activity log records for a document or organization.

Endpoint

POST https://api.velt.dev/v2/activities/get

Headers

x-velt-api-key · string · required

Your API key.

x-velt-auth-token · string · required

Your Auth Token.

Body

Params

data · object · required

Show properties

organizationId · string · required

Organization ID

documentId · string

Document ID. Filter activities to a specific document.

targetEntityId · string

Target entity ID. Filter activities to a specific entity (e.g., annotation ID).

featureTypes · string[]

Filter by feature type. Must be one or more of: "comment", "reaction", "recorder", "crdt", "custom".

actionTypes · string[]

Filter by action type (e.g., ["comment.add"]).

userId · string

Filter activities by the acting user’s ID.

activityIds · string[]

Fetch specific activities by ID.

order · string

Order results by timestamp. Must be asc or desc. Default: desc.

pageSize · number

Number of items to retrieve per page. Default: 1000. Minimum: 1.

pageToken · string

Encrypted pagination token retrieved from a previous API response.

Example Requests

1. Get by organizationId and documentId

{
  "data": {
    "organizationId": "org-123",
    "documentId": "doc-456",
    "order": "desc",
    "pageSize": 50
  }
}

2. Get by organizationId, documentId and featureTypes

{
  "data": {
    "organizationId": "org-123",
    "documentId": "doc-456",
    "featureTypes": ["comment"],
    "order": "desc",
    "pageSize": 50
  }
}

3. Get specific activity logs by activityIds

{
  "data": {
    "organizationId": "org-123",
    "activityIds": ["activity-001", "activity-002"]
  }
}

4. Get by targetEntityId with pagination

{
  "data": {
    "organizationId": "org-123",
    "documentId": "doc-456",
    "targetEntityId": "annotation-789",
    "pageSize": 20,
    "pageToken": "encryptedPageToken"
  }
}

Response

Success Response

{
  "result": {
    "status": "success",
    "message": "Activity(s) retrieved successfully.",
    "data": [
      {
        "id": "activity-001",
        "featureType": "comment",
        "actionType": "comment.add",
        "actionUser": {
          "userId": "user-1",
          "email": "[e-mail]",
          "name": "User Name"
        },
        "targetEntityId": "annotation-789",
        "displayMessageTemplate": "{{user}} added a comment",
        "displayMessageTemplateData": {
          "user": {
            "userId": "user-1",
            "name": "User Name"
          }
        },
        "metadata": {
          "apiKey": "yourApiKey",
          "documentId": "doc-456",
          "organizationId": "org-123"
        },
        "timestamp": 1722409519944
      }
    ],
    "pageToken": "nextPageToken"
  }
}

Failure Response

{
  "error": {
    "message": "ERROR_MESSAGE",
    "status": "INVALID_ARGUMENT"
  }
}

{
  "result": {
    "status": "success",
    "message": "Activity(s) retrieved successfully.",
    "data": [
      {
        "id": "activity-001",
        "featureType": "comment",
        "actionType": "comment.add",
        "actionUser": {
          "userId": "user-1",
          "email": "[e-mail]",
          "name": "User Name"
        },
        "targetEntityId": "annotation-789",
        "displayMessageTemplate": "{{user}} added a comment",
        "displayMessageTemplateData": {
          "user": {
            "userId": "user-1",
            "name": "User Name"
          }
        },
        "metadata": {
          "apiKey": "yourApiKey",
          "documentId": "doc-456",
          "organizationId": "org-123"
        },
        "timestamp": 1722409519944
      }
    ],
    "pageToken": "nextPageToken"
  }
}