Skip to main content

Retrieve content change logs of board items

GET 
/v2/orgs/:org_id/content-logs/items

Retrieves content changes for board items within your organization. Content changes are actions that users can perform on board items, such as updating a sticky note's text. You can retrieve results for a specific time period. You can also filter results based on the board IDs and the emails of users who created, modified, or deleted a board item. Additionally, results can be paginated for easier viewing and processing.

Required scope

contentlogs:export

Rate limiting

Level 4

Enterprise only

This API is available only for Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin.

Request​

Path Parameters

    org_id stringrequired

    Unique identifier of the organization.

    Example: 3074457345821141000

Query Parameters

    board_ids string[]

    Possible values: <= 15

    List of board IDs for which you want to retrieve the content logs.

    Example: [o9J_kzlUDmo=, u8J_kllZmDk=]
    emails string[]

    Possible values: <= 15

    Filter content logs based on the list of emails of users who created, modified, or deleted the board item.

    Example: [someone@domain.com, someoneelse@domain.com]
    from date-timerequired

    Filter content logs based on the date and time when the board item was last modified. This is the start date and time for the modified date duration. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    Example: 2022-03-30T17:26:50Z
    to date-timerequired

    Filter content logs based on the date and time when the board item was last modified. This is the end date and time for the modified date duration. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    Example: 2023-03-30T17:26:50Z
    cursor string

    A cursor-paginated method returns a portion of the total set of results based on the limit specified and a cursor that points to the next portion of the results. To retrieve the next portion of the collection, set the cursor parameter equal to the cursor value you received in the response of the previous request.

    Example: MTY2OTg4NTIwMDAwMHwxMjM=
    limit int32

    Possible values: >= 1 and <= 1000

    Default value: 1000

    The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response returns the cursor parameter with a value.

    Example: 1000
    sorting string

    Possible values: [asc, desc]

    Default value: asc

    Sort order in which you want to view the result set based on the modified date. To sort by an ascending modified date, specify asc. To sort by a descending modified date, specify desc.

    Example: asc

Responses​

Response from the API that includes content logs of board items such as data, size of the data list, pagination cursor, and pagination limit.

Schema

    limit int32

    The maximum number of results to return per call. If the number of logs in the response is greater than the limit specified, the response returns the cursor parameter with a value.

    size int32

    Number of results returned in the response considering the cursor and the limit values sent in the request. For example, if there are 20 results, the request does not have a cursor value, and the limit set to 10, the size of the results will be 10. In this example, the response will also return a cursor value that can be used to retrieve the next set of 10 remaining results in the collection.

    data

    object[]

    Contains the list of content logs for a board item.

  • Array [

    • id string

    Unique identifier of the content log.

    itemId string

    Unique identifier of the board item.

    type string

    Type of the board item.

    action string

    User action in the form of insert, update, or delete.

    boardKey string

    Unique identification of the board to which the item belongs.

    hidden boolean

    Indicates if the board is a hidden board. Returns true if board item is hidden.

    createdAt date-time

    Date and time when the board item was created.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    createdBy

    object

    Contains user information.

    id string

    Unique identifier of the user.

    email string

    Email of the user.

    firstName string

    First name of the user.

    lastName string

    Last name of the user.

    modifiedAt date-time

    Date and time when the board item was last modified.
    Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

    modifiedBy

    object

    Contains user information.

    id string

    Unique identifier of the user.

    email string

    Email of the user.

    firstName string

    First name of the user.

    lastName string

    Last name of the user.

    logData

    object

    Content log object representing the current state of the board item at the modifiedAt time.

    text string

    Text extracted from the board item.

    metadata

    object

    Metadata representing more information that might be relevant for a specific board item.

    property name* string

  • ]

    • cursor string

    Indicator of the position of the next page of the result. To retrieve the next page, make another query setting its cursor field to the value returned by the current query. If the value is empty, there are no more pages to fetch.

    type string

    Default value: cursor-list

    Type of the object returned.

Loading...