Activity

Fetch activity

Returns a paginated list of activity items (change events) in your workspace, optionally filtered by project, text item, library component, or entity type.

get/activity

Request

Base URL: https://api.dittowords.com/v2
URL: https://api.dittowords.com/v2/activity
Auth: API key in header Authorization

Query parameters

projectIdsstring

Comma-separated list of project developer IDs to filter activity for. Activity matching any of the provided project, text item, or component IDs is included (OR logic across all three ID filters).

textItemIdsstring

Comma-separated list of text item developer IDs to filter activity for. Activity matching any of the provided project, text item, or component IDs is included (OR logic across all three ID filters).

componentIdsstring

Comma-separated list of library component developer IDs to filter activity for. Activity matching any of the provided project, text item, or component IDs is included (OR logic across all three ID filters).

entityType'textItem' | 'component' | 'variant' | 'variable'

Narrows results to a single entity type (AND logic with the ID filters). One of: textItem (text item changes), component (library component changes), variant (variant changes on text items or components), variable (variable changes). When combined with projectIds, textItemIds, or componentIds, only activity that matches both the ID filters and this entity type is returned.

limitstring

Maximum number of activity items to return (default: 50, max: 200)

cursorstring

The nextCursor value from a previous response, used to fetch the next page

Response

Returns a paginated list of activity items matching the requested filters

nextCursorstring nullable required

Opaque cursor for fetching the next page of results. Pass as the cursor query parameter in the next request. Null if there are no more results.

Example response

{
  "activity": [
    {
      "type": "edit",
      "date": "2024-06-01T12:34:56.000Z",
      "user": {
        "name": "Alice"
      },
      "projectId": "my-project",
      "textItemIds": [
        "welcome-header"
      ],
      "componentId": null,
      "data": {}
    }
  ],
  "nextCursor": "NmExODU2MmI3ZDllMDAyNzk5OTk1ZWVi"
}

Changes

No recorded changes to this operation across all 1 revision of this API.