コンテンツへスキップ
Reports

List reports

GET/api/v1alpha1/reports

Returns the immutable reports that belong to an analysis run.

認証

apiKey
認証Bearer <token>

場所: header

クエリパラメーター

cursor?string

Opaque cursor returned as next_cursor by the previous page.

limit?number

Number of reports to return. The default is 25 and the maximum is 100.

形式int32
範囲1 <= value <= 100
デフォルト25
run_id*string

Analysis-run identifier whose reports are returned.

expand[]?array<>

Optional related data to include:

  • events: timeline event details.
  • events.evidence: evidence attached to each timeline event.
  • evidence: answer evidence details.
  • provenance: curated provenance details.
  • snapshots: stored profile, input, and output snapshot references.
  • content: rendered report content.
  • manifest: report trust bindings and evidence URLs. Expand depth is limited to two path segments. For this endpoint, use content or manifest.

レスポンスボディ

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/v1alpha1/reports?run_id=run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab" \  -H "Authorization: Bearer $DEEPFRAME_API_KEY"
{  "data": [    {      "analysis_profile_ref": "snap_profile-snapshot-example",      "content_identity": "snap_report-content-example",      "content_ref": "artifact://rep_0190b5d4-7e1f-7a2b-9c3d-1234567890ab/content",      "content_type": "application/json",      "created_at": "2026-08-21T09:04:31.000Z",      "format": "json",      "id": "rep_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "output_identity": "snap_output-snapshot-example",      "report_template_ref": "procedure-report-ja@1",      "request_id": "0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "run_id": "run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "updated_at": "2026-08-21T09:04:31.000Z"    },    {      "analysis_profile_ref": "snap_profile-snapshot-example",      "content_identity": "snap_report-content-example",      "content_ref": "artifact://rep_0190b5d4-markdown/content",      "content_type": "text/markdown",      "created_at": "2026-08-21T09:04:31.000Z",      "format": "markdown",      "id": "rep_0190b5d4-markdown",      "output_identity": "snap_output-snapshot-example",      "report_template_ref": "procedure-report-ja@1",      "request_id": "0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "run_id": "run_0190b5d4-7e1f-7a2b-9c3d-1234567890ab",      "updated_at": "2026-08-21T09:04:31.000Z"    }  ],  "has_more": false,  "next_cursor": null}