Get segments

get

https://{subdomain}.peakon.com/api/v1/engagement/contexts/{contextId}/segments/v2

Obtain a list of segments. The id of each segment can be used to get full engagement details using other methods in this area.

Path Params

contextId

string

required

A company or segment context id. Param is a string formatted as company_[companyId] or segment_[segmentId].

Query Params

filter[employee.segmentIds]

array of integers

The array of segment ids that the result should be filtered for. The segment ids should be sent comma-separated and ending with "$contains".

filter[employee.segmentIds]

filter[question.driver]

string

enum

filter[question.subdriver]

string

enum

filter[question.valueId]

integer

filter[round.type]

string

enum

Defaults to automatic

The type of rounds to include data for

Allowed:

string

required

A text to search for in segments

Response

Language

Credentials

Bearer

JWT

URL

Response

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

application/json

200A JSONAPI resource of type 'engagement_segments'