API Reference

Get by driver for context

get
https://{subdomain}.peakon.com/api/v1/engagement/contexts//drivers/

Return the engagement details for the given driver for the given context.

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

enum
required

One of 15 supported engagement drivers

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

Includes observations array in the returned object, defaults to false.

boolean

Includes participation in the returned object, defaults to false.

string
enum

Limit query to a specific date interval, defaults to quarter.

Allowed:
Response

Updated 5 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 5 months ago