GuidesAPI DocsChangelogMy AppsSeismic Exchange
API Docs

Group requests by specified attributes

get
https://api.seismic.com/programs/v2/spaces//requests/groupby

Groups requests by a specified attribute (priority, status, assignee, creator, or custom property) and applies aggregations to calculate metrics within each group.
This endpoint enables advanced analytics, reporting dashboards, and workload distribution analysis. Supports extensive filtering to analyze specific request subsets before grouping.

Key Features:

  • Groups requests by standard fields (priority, status, assignee, creator) or custom properties
  • Applies aggregations (count, sum, average, min, max) to calculate group metrics
  • Supports comprehensive filtering before grouping for targeted analytics
  • Provides cursor-based pagination for large result sets
  • Returns group summaries with counts and aggregated values
  • Enables building analytics dashboards and workload distribution reports

Authorization Logic:

  1. User must have a valid JWT token with viewing or management scopes
  2. Requests are filtered based on user's access permissions before grouping

Usage Example:
Analyze workload distribution by grouping requests by assignee with count aggregation, or track request priorities by grouping by status with min/max planned end dates to identify bottlenecks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length between 7 and 22

The unique identifier of the space containing the target entity. This determines the scope of entity queries and ensures proper access control. The space must be accessible to the authenticated user with appropriate permissions. It can be the unique identifier (GUID) of the space or the word "default" to indicate the default programs space. Common values include "default" and "rkr83lapKkyCJuLLWqLqzB".

Query Params
date-time

Optional filter for requests with planned end date on or after this date (inclusive) before grouping.

date-time

Optional filter for requests with planned end date before this date (exclusive) before grouping.

date-time

Optional filter for requests with planned start date on or after this date (inclusive) before grouping.

date-time

Optional filter for requests with planned start date before this date (exclusive) before grouping.

date-time

Optional filter for requests created on or after this date (inclusive) before grouping.

date-time

Optional filter for requests created before this date (exclusive) before grouping.

date-time

Optional filter for requests updated on or after this date (inclusive) before grouping.

date-time

Optional filter for requests updated before this date (exclusive) before grouping.

assigneeIds
array of strings

Optional array of user IDs to filter requests by assignee before grouping.

assigneeIds
priorities
array of strings

Optional array of priority values to filter requests before grouping. Available values: critical, high, medium, low.

priorities
assignerIds
array of strings

Optional array of user IDs to filter requests by assigner before grouping.

assignerIds
stepIds
array of int32s

Optional array of workflow step IDs to filter requests by current step before grouping.

stepIds
string
length between 1 and 128

Optional status schema ID to filter requests using a specific status configuration before grouping.

string

Optional cursor for pagination. Use the cursor from the previous response to retrieve the next page of grouped results.

int32

Optional limit for number of groups to return per page. Defaults to 50 if not specified.

string

Optional program ID to filter requests associated with a specific program before grouping. Use this parameter
instead of the deprecated projectId parameter.

boolean

Optional boolean to filter requests based on program association status before grouping. Use this parameter
instead of the deprecated hasProject parameter.

followerIds
array of strings

Optional array of user IDs to filter requests by followers before grouping.

followerIds
associatedNodeIds
array of strings

Optional array of content node IDs to filter requests by associated content before grouping. Requests can only
be associated with content items, not programs or tasks.

associatedNodeIds
string

Optional custom property ID to group requests by. Required if groupBy parameter is not specified.
Use this to group by custom field values for advanced analytics.

string
enum

Optional standard field to group requests by. Available values: priority, status, assigneeId, creatorId.
Required if groupByCustomPropertyId is not specified.

Allowed:
aggregations
array of strings

Comma-separated list of aggregation functions to apply to each group.

Format: field:function.

Supported functions: count, sum, avg, min, max.

aggregations
customProperties
object

Optional dictionary of custom property filters applied before grouping for advanced search.

Filter Syntax:

  • customProperties[{propertyId}][operator]={operator} - Comparison operator
  • customProperties[{propertyId}][id]=%22{valueId}%22 - Filter by value ID (URL-encoded with %22)
  • customProperties[{propertyId}][value]=%22{value}%22 - Filter by value (URL-encoded with %22)

Example: customProperties[field456][operator]=ArrayContains&customProperties[field456][id]=%22option789%22

string

Optional keyword to search within request titles before grouping.

Responses

Updated 6 days ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 6 days ago