API Reference
Log In
API Reference

Get insights run

Fetch one insights run by ID, scoped to the authenticated team, including its status, findings, recommendations and feedback. dashboard_url links to the run on the Insights page in the Revenium app.

Full mode (the default) returns findings and recommendations both as JSON strings and as parsed objects. Slim mode (slim=true) returns a short ranked list of recommendations. In either mode, findingsCount and recommendationsCount give totals, and findingsTruncated and findingsConsideredCount show whether findings were capped before the recommendations were written.

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

Set to true for a compact response: the full findings and recommendations are left out and recommendationsSummary lists the recommendations instead. Defaults to false.

string

Hashed id of the team to answer for. Optional. With a user token it may be any team the user belongs to; without it the user's default team answers. An API key always answers for its own team, and naming any other team is refused with 403.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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