API Reference

Get segments

get
https://{subdomain}.peakon.com/api/v1/engagement/contexts//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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
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]
string
enum
string
enum
integer
string
enum
Defaults to automatic

The type of rounds to include data for

Allowed:
string
required

A text to search for in segments

Response

Updated 6 months ago

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

Updated 6 months ago