How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Peakon Engagement API

Retrieving engagement scores

Peakon Engagement API is one of 8 APIs that Peakon publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Engagement. The published artifact set on APIs.io includes an OpenAPI specification and authentication docs.

This API exposes 9 operations across 9 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 1.1.0.

Requests are made against a single base URL, https://{subdomain}.peakon.com/api/v1/.

9 operations 9 paths 5 schemas 9 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.1.0
Base URL
https://api.peakon.com/api/v1/
Resource Areas
1

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 9 GET. Each is listed below with its method, path, parameters, and response codes.

Engagement 9

Retrieving engagement scores

GET
/engagement/overview
Get overview
3 params → 200
GET
/engagement/contexts/{contextId}/overview
Get overview for context
4 params → 200
GET
/engagement/drivers
Get for drivers
8 params → 200
GET
/engagement/contexts/{contextId}/drivers
Get for drivers for context
9 params → 200
GET
/engagement/drivers/{driver}
Get by driver
9 params → 200
GET
/engagement/contexts/{contextId}/drivers/{driver}
Get by driver for context
10 params → 200
GET
/engagement/contexts/{contextId}/segments/v2
Get segments
7 params → 200
GET
/engagement/contexts/{contextId}/segments/groups
Get segments groups
6 params → 200
GET
/engagement/contexts/{contextId}/segments/v2/attributes/{attributeId}
Get segments for attribute
7 params → 200

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are engagementSegments (4 properties), engagementSegmentGroups (4 properties), engagementDrivers (3 properties), engagementOverviews (3 properties). Each schema is shown below with its type and property counts.

engagementOverviews
object
3 properties
engagementSegmentGroups
object
4 properties
resourceIdentifier
object
2 properties
engagementDrivers
object
3 properties
engagementSegments
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

peakon-engagement-api-openapi.yml Raw ↑

Other APIs Peakon publishes across the network.

Peakon Actions API
Peakon Answers API
Peakon Audits API
Peakon Authentication API
Peakon Employees API
Peakon Scores API
Peakon Segments API
Where this information came from

This is an independent, third-party profile of Peakon Engagement API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.