Insights Reports

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

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

targetOrgstringRequired

Salesforce target org username

Example: admin@example.com

includeManagedbooleanOptional

Include managed-package metadata in the report

Default: false

includePopulationbooleanOptional

Run field-population analysis (slow on large orgs)

Default: true

Responses

202

Workflow run accepted or already in flight.

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/insights/reports/refresh

POST /sfp/api/insights/reports/refresh HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "targetOrg": "admin@example.com",
  "includeManaged": false,
  "includePopulation": true
}

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetOrgstringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports/active

GET /sfp/api/insights/reports/active?targetOrg=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetOrgstringRequired

limitstringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports/runs

GET /sfp/api/insights/reports/runs?targetOrg=text&limit=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

Upload an HTML insights report to object storage (keyed by target org).

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

targetOrgstringRequired

Salesforce target org username (acts as the storage key namespace)

Example: admin@example.com

capturedAtstringRequired

ISO 8601 capture timestamp

Example: 2026-05-17T12:00:00.000Z

htmlstringOptional

Rendered HTML report (UTF-8 string)

combinedJsonobjectOptional

Combined OrgInsightResult JSON (the full result the CLI/Hatchet job produced).

Responses

201

Stored. Returns the storage key.

No content

403

Forbidden - Requires role: owner, member, application

post/sfp/api/insights/reports/upload

POST /sfp/api/insights/reports/upload HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "targetOrg": "admin@example.com",
  "capturedAt": "2026-05-17T12:00:00.000Z",
  "html": "text",
  "combinedJson": {},
  "sections": [
    {
      "id": "text",
      "json": {}
    }
  ]
}

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

403

Forbidden - Requires role: owner, member, application

No content

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

GET /sfp/api/insights/reports/available-orgs HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetOrgstringRequired

limitstringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports

GET /sfp/api/insights/reports?targetOrg=text&limit=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetOrgstringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports/latest

GET /sfp/api/insights/reports/latest?targetOrg=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

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

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

targetOrgstringRequired

artifactstringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports/latest/content

GET /sfp/api/insights/reports/latest/content?targetOrg=text&artifact=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

Download a stored artifact by its full storage key.

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

0stringRequired

Responses

403

Forbidden - Requires role: owner, member, application

No content

get/sfp/api/insights/reports/content/*

GET /sfp/api/insights/reports/content/* HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

403

Forbidden - Requires role: owner, member, application

No content

Last updated 20 hours ago

Was this helpful?