HomeGuidesAPI ReferenceChangelog
Terms of Use
API Reference

CoOperator insight / read

⚠️ Experimental endpoint — not yet a stable contract. This resource ships as experimental / beta. While experimental, its schema and behaviour may change without a version bump — including breaking changes within v1.0 itself. Anyone consuming it does so for evaluation only, or by coordinating adoption with their account manager so changes can be sequenced with them. It graduates to a stable, version-locked contract (where the normal breaking-change rules apply) only when this experimental notice is removed.

Get one API insight.

Requires a Public API token whose service admin has the Access CoOperator permission and an installed, enabled CoOperator app.

Only insights submitted through this API are visible. A saved insight is visible only when the service admin's current visibility matches the audience used for its analysis, including operator, partner, sub-operator and permission restrictions. Administrators with matching visibility can read it regardless of who submitted it. Full-access insights and legacy insights without an audience are available only to full-access administrators, who have no operator, partner or sub-operator restriction and can see every record returned by the Public API in the tenant. Broader access does not automatically grant access to a restricted-audience insight. Visibility is checked on every read. Admins of any other kind, such as installation and maintenance companies, are refused with 403. Inaccessible insight IDs are not exposed and return 404.

A failed insight exposes no failure details. Callers should enforce their own polling timeout because stale pending insights are not automatically expired.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
integer
required
Responses

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