Group by programs

get

https://api.seismic.com/programs/v2/spaces/{spaceId}/programs/groupby

Group programs by attributes. You can group attributes by 'manager' and 'creator' via the groupBy attribute. aggregations can also be used to get minimum(min), maximum(max), average(avg), and summation(sum) of values. (ex. createdAt:min) All other list filters can be used in conjunction with grouping.

Path Params

spaceId

string

required

Space ID

Query Params

plannedEndDateFrom

date-time

filter by program "plannedEndDate/DueDate" (inclusive)

plannedEndDateTo

date-time

filter by program "plannedEndDate/DueDate" (exclusive)

plannedStartDateFrom

date-time

filter by program "plannedStartDate/StartDate" (inclusive)

plannedStartDateTo

date-time

filter by program "plannedStartDate/StartDate" (exclusive)

managerIds

array of strings

A list of assignees' user Ids to filter by

managerIds

creatorIds

array of strings

A list of assigners' user Ids to filter by.

creatorIds

cursor

string

A token used to guide the next page window

limit

int32

Number of items to return per page, default: 50

followerIds

array of strings

A list of followers' user id

followerIds

associatedNodeIds

array of strings

A list of Associated node ids to filter by

associatedNodeIds

groupByCustomPropertyId

string

The custom property to group by

groupBy

string

enum

The attribute to group by. Available values : managerId, creatorId, audience, pages, trackers, topics, programType, outcomeKpiFirst, outcomeKpiSecond, outcomeKpiThird

aggregations

array of strings

Aggregations to apply to each group

aggregations

customProperties

object

Filter by custom properties

title

string

Keyword values to search for on program titles

archived

boolean

Query only activated or deactivated programs

programType

string

enum

ProgramType enum to filter by

Allowed:

outcomeKpiFirst

string

enum

First OutcomeKpi/Metric enum to filter by

Allowed:

outcomeKpiSecond

string

enum

Second OutcomeKpi/Metric enum to filter by

Allowed:

outcomeKpiThird

string

enum

Third OutcomeKpi/Metric enum to filter by

Allowed:

currentPhases

array of strings

A list of current phase IDs to query by

currentPhases

includeDeactivatedPrograms

boolean

Defaults to false

Indicator to allow for inclusion of deactivated programs (ignored when enabled
is passed)

Responses

Language

Credentials

Header

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Success

400Bad Request

401Unauthorized

500Server Error