Run an Insights segment

Runs the segment for the authenticated user and returns immediately with a run
reference and its status; it does not wait for the segment run to finish. The
run only covers the companies the token's user can access in Silverfin, and
never changes the segment's definition.

If a run of this segment is already in progress, no new run is started: the
response describes that pending run: the pending payload documented on
GET /segments/{id}/results, without its message. Poll that endpoint
until it finishes. Otherwise a new execution is
created (a 202) and any previously generated results are discarded.

A firm can have a limited number of runs in progress at the same time;
further requests are rejected with a 409 until a run
finishes. Runs started from the Silverfin UI count towards that limit.
Only the firm's own segments can be run through the API; recommended
segments cannot.

This endpoint exists in API v4 only; on the deprecated v3 API it returns a 404.

This endpoint requires a user OAuth token and Insights Premium.

Required scope: insights:write

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

Segment id

Responses

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