Docs
flxbl.ioStatusContact us
codevsfp CLIsfp serverlibraries

Insights Reports

sfp server API reference for Insights Reports: 9 endpoints.

Trigger the Hatchet collect-org-insight workflow on demand for a target org. Idempotent: returns the in-flight runId with status=already-running if a prior run is still active.

POST/sfp/api/insights/reports/refresh

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/insights/reports/refresh" \  -H "Content-Type: application/json" \  -d '{    "targetOrg": "admin@example.com"  }'
Empty

Return the in-flight collect-org-insight run for a target org, if one is currently dispatched/running.

GET/sfp/api/insights/reports/active

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

targetOrg*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/active?targetOrg=string"
Empty

Recent collect-org-insight executions for a target org (any status), newest first. Backed by sfp_task_executions.

GET/sfp/api/insights/reports/runs

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

targetOrg*string
limit*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/runs?targetOrg=string&limit=string"
Empty

Upload an HTML insights report to object storage (keyed by target org). Internal worker-only: locked to InternalApiGuard + the `application` role, so it is reachable only by the collect-org-insight Hatchet worker (application token) from the private network — interactive members/owners are rejected. Users request a report via POST /insights/reports/refresh, which dispatches the worker.

POST/sfp/api/insights/reports/upload

Authorization

access-token
AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sfp/api/insights/reports/upload" \  -H "Content-Type: application/json" \  -d '{    "targetOrg": "admin@example.com",    "capturedAt": "2026-05-17T12:00:00.000Z"  }'
Empty

List registered orgs with an available HTML insights report, newest first.

GET/sfp/api/insights/reports/available-orgs

Authorization

access-token
AuthorizationBearer <token>

In: header

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/available-orgs"
Empty

List uploaded insights runs for a target org (newest first).

GET/sfp/api/insights/reports

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

targetOrg*string
limit*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports?targetOrg=string&limit=string"
Empty

Return the most recent insights run for a target org, including the artifact keys (report.html, report.json, sections/<id>.json).

GET/sfp/api/insights/reports/latest

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

targetOrg*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/latest?targetOrg=string"
Empty

Stream a specific artifact from the most recent run. ?artifact=report.html | report.json | sections/<id>.json

GET/sfp/api/insights/reports/latest/content

Authorization

access-token
AuthorizationBearer <token>

In: header

Query Parameters

targetOrg*string
artifact*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/latest/content?targetOrg=string&artifact=string"
Empty

Download a stored artifact by its full storage key.

GET/sfp/api/insights/reports/content/*

Authorization

access-token
AuthorizationBearer <token>

In: header

Path Parameters

0*string

Response Body

curl -X GET "https://example.com/sfp/api/insights/reports/content/*"
Empty

Health

sfp server API reference for Health: 4 endpoints.

Integrations

sfp server API reference for Integrations: 15 endpoints.