API Reference

Get segments for attribute

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

Return the segments with engagement data within the given attribute.

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].

integer
required

The id of the attribute to get segments for. Attribute ids can be retrieved using /engagement/contexts/{contextId}/segments.

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:
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