Skip to main content
POST
Get Jointl Insights

Authorizations

Authorization
string
header
required

OAuth access token issued for the REST resource.

Body

application/json
endDate
string

Inclusive UTC end date in YYYY-MM-DD. Omit both dates for the trailing six-month default.

Pattern: ^\d{4}-\d{2}-\d{2}$
selectedCompanies
string[]

Exact authorized Jointl company IDs; empty means every authorized company.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
selectedFlows
string[]

Exact authorized Flow IDs; empty means every authorized Flow for this view.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
selectedRoles
string[]

Exact Employee role-title labels; empty means every authorized role.

Maximum array length: 100
Required string length: 1 - 180
startDate
string

Inclusive UTC start date in YYYY-MM-DD. Omit both dates for the trailing six-month default.

Pattern: ^\d{4}-\d{2}-\d{2}$
view
enum<string>
default:general

general maps to /insights, performance to /insights?view=performance, and exitIntelligence to /insights?view=exit-intelligence.

Available options:
general,
performance,
exitIntelligence

Response

Operation completed.

data
object
required
requestId
string
required

Request correlation identifier.