Developer Portal for YouTrack and Hub Help

Issue Activities Page

This resource provides access to issue-related activity that is wrapped inside a page object. The main advantage of the page in comparison to a list of activities is cursors. The page provides boundary marks that supports iteration over the activities from the place the page is finished.

Resource

/api/activitiesPage

Returned entity

ActivityCursorPage. For the description of the entity attributes, see Supported Fields section.

ActivityCursorPage attributes

Represents a page object that wraps a list of issue activities. The main advantage of the page in comparison to a list of activities is cursors. The page provides boundary marks that allow continuous iteration over the activities from the place the page is finished.

Related Resources

Below you can find the list of resources that let you work with this entity.

Attributes

This table describes attributes of the ActivityCursorPage entity.

  • To receive an attribute in the response from the server, specify it explicitly in the fields request parameter.

  • To update an attribute, provide it in the body of a POST request.

Field

Type

Description

id

String

The ID of the activity cursor page. Read-only.

activities

Array of ActivityItems

The list of activities in the page. Read-only.

afterCursor

String

A string value that is required to retrieve the next page of activities. Read-only.

beforeCursor

String

A string value that is required to retrieve the previous page of activities. Read-only.

hasAfter

Boolean

Indicates if the next page exists. Read-only.

hasBefore

Boolean

Indicates if the previous page exists. Read-only.

reverse

Boolean

Indicates whether the order of returning activities on the page is from newest to oldest or the opposite. If false, then the oldest activity item that matches a selected filter is returned first. If true, then the newest activity is returned first. By default, false. Read-only.

Last modified: 7 November 2024