Options for searching issue activity performed by one or more users.

interface UserActivityParams {
    expand?: string[];
    fields?: string[];
    from?: string;
    jql?: string;
    maxResults?: number;
    startAt?: number;
    to?: string;
    validateQuery?: boolean;
}

Properties

expand?: string[]

Fields to expand (e.g. ['changelog'])

fields?: string[]

Issue fields to include in the response

from?: string

Lower bound for activity time, accepted by Jira's updatedBy JQL function. Examples: '-30d', '2024-01-01', '2024/01/01'.

jql?: string

Additional JQL to combine with the user activity clauses using AND. Example: 'project = PROJ AND statusCategory != Done'.

maxResults?: number

Maximum number of results to return

startAt?: number

Index of the first result (0-based)

to?: string

Upper bound for activity time, accepted by Jira's updatedBy JQL function. Examples: '2024-01-31', '2024/01/31'.

validateQuery?: boolean

Whether Jira should validate the JQL query