Audits

List information request activity

Retrieves a paginated list of activity logs for an information request, providing a complete audit trail of all changes and actions.

This endpoint supports delta synchronization via the changedSinceDate parameter, allowing efficient polling for changes without retrieving the entire dataset.

Pagination usage:

Make initial request with desired pageSize
Check results.pageInfo.hasNextPage to see if more data exists
If true, use results.pageInfo.endCursor as pageCursor in next request
Repeat until hasNextPage is false

Delta sync usage:

Store the timestamp of your last sync
Pass that timestamp as changedSinceDate
Only activity created since that timestamp is returned
Process updates to track all changes to the information request
Update your last sync timestamp to the current time

GET

audits

{auditId}

information-requests

{requestId}

activity

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.listInformationRequestActivity({
    auditId: "<id>",
    requestId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "data": [
      {
        "id": "6650a7d13680f3b61a0cd3c1",
        "activityType": "CHANGE_STATUS",
        "timestamp": "2024-05-05T12:00:00.000Z",
        "userEmail": "user@example.com",
        "oldStatus": "NEEDS_EVIDENCE",
        "newStatus": "READY_FOR_AUDIT",
        "reason": "Status updated after review"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "NjY1MGE3ZDEzNjgwZjNiNjFhMGNkM2Mx",
      "endCursor": "NjY1MGE3ZDEzNjgwZjNiNjFhMGNkM2Mx"
    }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

auditId

string

required

requestId

string

required

Query Parameters

pageSize

integer<int32>

default:10

Maximum number of activity entries to return per page. Controls the maximum number of items returned in one response from the API.

Required range: 1 <= x <= 100

pageCursor

string

Pagination cursor from a previous response. Provide to fetch the next page of activity logs. A marker or pointer, telling the API where to start fetching items for the subsequent page in a paginated dataset. Note that the requested page will not include the item that corresponds to this cursor but will start from the one immediately after this cursor.

changedSinceDate

string<date-time>

Includes activity logs that have changed since changedSinceDate.

Response

200 - application/json

results

object

required

Show child attributes

List comments for an information requestRetrieves a paginated list of comments for an information request, enabling auditors to view communication history and collaborate with customers. This endpoint always includes soft-deleted records (where `deletionDate !== null`). Clients should check the `deletionDate` field to identify and handle deleted records appropriately in their systems. This endpoint supports delta synchronization via the `changedSinceDate` parameter, allowing efficient polling for changes without retrieving the entire dataset. Pagination usage: 1. Make initial request with desired `pageSize` 2. Check `results.pageInfo.hasNextPage` to see if more data exists 3. If true, use `results.pageInfo.endCursor` as `pageCursor` in next request 4. Repeat until `hasNextPage` is false Delta sync usage: 1. Store the timestamp of your last sync 2. Pass that timestamp as `changedSinceDate` 3. Only comments created, modified, or deleted since that timestamp are returned 4. Process updates, including soft-deletes (deletionDate !== null) 5. Update your last sync timestamp to the current time

⌘I

TypeScript

import { Vanta } from "vanta-auditor-api-sdk";

const vanta = new Vanta({
  bearerAuth: process.env["VANTA_BEARER_AUTH"] ?? "",
});

async function run() {
  const result = await vanta.audits.listInformationRequestActivity({
    auditId: "<id>",
    requestId: "<id>",
  });

  console.log(result);
}

run();

{
  "results": {
    "data": [
      {
        "id": "6650a7d13680f3b61a0cd3c1",
        "activityType": "CHANGE_STATUS",
        "timestamp": "2024-05-05T12:00:00.000Z",
        "userEmail": "user@example.com",
        "oldStatus": "NEEDS_EVIDENCE",
        "newStatus": "READY_FOR_AUDIT",
        "reason": "Status updated after review"
      }
    ],
    "pageInfo": {
      "hasNextPage": false,
      "hasPreviousPage": false,
      "startCursor": "NjY1MGE3ZDEzNjgwZjNiNjFhMGNkM2Mx",
      "endCursor": "NjY1MGE3ZDEzNjgwZjNiNjFhMGNkM2Mx"
    }
  }
}