Preview Bundle Flow

curl --request POST \
  --url https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "history": {
    "changed_answer_counts": {},
    "elapsed_ms_total": 0,
    "first_answers": {},
    "served_question_ids": [
      "<string>"
    ],
    "skipped_question_ids": [
      "<string>"
    ]
  },
  "include_report": false,
  "locale": "en",
  "page_size": 5,
  "responses": {},
  "signals": {}
}
'

import requests

url = "https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow"

payload = {
    "history": {
        "changed_answer_counts": {},
        "elapsed_ms_total": 0,
        "first_answers": {},
        "served_question_ids": ["<string>"],
        "skipped_question_ids": ["<string>"]
    },
    "include_report": False,
    "locale": "en",
    "page_size": 5,
    "responses": {},
    "signals": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    history: {
      changed_answer_counts: {},
      elapsed_ms_total: 0,
      first_answers: {},
      served_question_ids: ['<string>'],
      skipped_question_ids: ['<string>']
    },
    include_report: false,
    locale: 'en',
    page_size: 5,
    responses: {},
    signals: {}
  })
};

fetch('https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'history' => [
        'changed_answer_counts' => [
                
        ],
        'elapsed_ms_total' => 0,
        'first_answers' => [
                
        ],
        'served_question_ids' => [
                '<string>'
        ],
        'skipped_question_ids' => [
                '<string>'
        ]
    ],
    'include_report' => false,
    'locale' => 'en',
    'page_size' => 5,
    'responses' => [
        
    ],
    'signals' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow"

	payload := strings.NewReader("{\n  \"history\": {\n    \"changed_answer_counts\": {},\n    \"elapsed_ms_total\": 0,\n    \"first_answers\": {},\n    \"served_question_ids\": [\n      \"<string>\"\n    ],\n    \"skipped_question_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_report\": false,\n  \"locale\": \"en\",\n  \"page_size\": 5,\n  \"responses\": {},\n  \"signals\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"history\": {\n    \"changed_answer_counts\": {},\n    \"elapsed_ms_total\": 0,\n    \"first_answers\": {},\n    \"served_question_ids\": [\n      \"<string>\"\n    ],\n    \"skipped_question_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_report\": false,\n  \"locale\": \"en\",\n  \"page_size\": 5,\n  \"responses\": {},\n  \"signals\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/organizations/{organization_id}/apps/{app_id}/bundles/{bundle_id}/preview-flow")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"history\": {\n    \"changed_answer_counts\": {},\n    \"elapsed_ms_total\": 0,\n    \"first_answers\": {},\n    \"served_question_ids\": [\n      \"<string>\"\n    ],\n    \"skipped_question_ids\": [\n      \"<string>\"\n    ]\n  },\n  \"include_report\": false,\n  \"locale\": \"en\",\n  \"page_size\": 5,\n  \"responses\": {},\n  \"signals\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "batch": {
    "batch_id": "<string>",
    "complete": true,
    "progress": 0.5,
    "trace": {
      "mandatory": true,
      "policy_version": "<string>",
      "selected_question_id": "<string>",
      "stop_reason": "mandatory_guardrail"
    },
    "questions": [
      {
        "id": "<string>",
        "input": "single_select",
        "options": [
          {
            "id": "<string>",
            "label": "<string>"
          }
        ],
        "prompt": "<string>",
        "required": false
      }
    ],
    "section": {
      "answered": 1,
      "count": 2,
      "id": "<string>",
      "position": 2,
      "title": "<string>",
      "total": 1,
      "description": "<string>"
    },
    "why": "<string>"
  },
  "session": {
    "branding": {
      "display_name": "<string>",
      "primary_color": "<string>"
    },
    "consent": {
      "notice_text": "<string>",
      "notice_version": "<string>",
      "purpose": "<string>"
    },
    "consented": true,
    "evaluation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "expires_at": "2023-11-07T05:31:56Z",
    "last_seen_at": "2023-11-07T05:31:56Z",
    "locale": "<string>",
    "renderer_mode": "hosted",
    "session_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "active",
    "voice_processing_consent": {
      "notice_text": "<string>",
      "notice_version": "<string>",
      "purpose": "<string>"
    },
    "voice_processing_consented": true,
    "voice_interview": {
      "available": true,
      "consent": {
        "notice_text": "<string>",
        "notice_version": "<string>",
        "purpose": "<string>"
      },
      "consented": true,
      "status": "not_started",
      "target_minutes_max": 123,
      "target_minutes_min": 123,
      "unavailable_reason": "locale"
    }
  },
  "report": {
    "created_at": "2023-11-07T05:31:56Z",
    "evaluation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": "pending",
    "alignment": {},
    "completed_at": "2023-11-07T05:31:56Z",
    "comprehensive": {
      "audience": "participant",
      "consistency": {
        "items": [
          {
            "detail": "<string>",
            "evidence_refs": [
              "<string>"
            ],
            "id": "<string>",
            "kind": "guardrail",
            "status": "unresolved",
            "title": "<string>",
            "follow_up": "none",
            "follow_up_refs": [
              "<string>"
            ],
            "origin": "deterministic",
            "severity": "hard"
          }
        ],
        "summary": {
          "evidence_refs": [
            "<string>"
          ],
          "id": "<string>",
          "text": "<string>",
          "contradicting_refs": [
            "<string>"
          ],
          "facet": "<string>",
          "origin": "deterministic",
          "stated_intention": false,
          "support": "supported"
        },
        "hidden": false
      },
      "coverage": {
        "answered": 123,
        "asked": 123,
        "channels": [
          "<string>"
        ],
        "concepts": [
          {
            "concept": "<string>",
            "label": "<string>",
            "answered_share": 123,
            "confidence": 123,
            "coverage": 123,
            "satisfied": true
          }
        ],
        "declined": 123,
        "delivery_mode": "<string>",
        "delivery_note": "<string>",
        "gap_refs": [
          "<string>"
        ],
        "limitations": [
          {
            "evidence_refs": [
              "<string>"
            ],
            "id": "<string>",
            "text": "<string>",
            "contradicting_refs": [
              "<string>"
            ],
            "facet": "<string>",
            "origin": "deterministic",
            "stated_intention": false,
            "support": "supported"
          }
        ],
        "not_asked": 123,
        "sections": [
          {
            "answered": 123,
            "declined": 123,
            "hidden": 123,
            "not_asked": 123,
            "section_id": "<string>",
            "skipped": 123,
            "title": "<string>",
            "total": 123,
            "unanswered": 0
          }
        ],
        "skipped": 123,
        "active_minutes": 123,
        "answer_changes": 123,
        "completion_percent": 123,
        "hidden": false,
        "question_activity": [
          {
            "label": "<string>",
            "question_id": "<string>",
            "response_state": "<string>",
            "active_seconds": 123,
            "answer_changes": 0,
            "channel": "<string>",
            "voice_corrections": 0
          }
        ],
        "reused": 0,
        "total_duration_minutes": 123,
        "unanswered": 0,
        "voice_corrections": 123
      },
      "dimensions": [
        {
          "answers_counted": 123,
          "axis": "<string>",
          "band_label": "<string>",
          "bands": [
            {
              "expected": true,
              "label": "<string>",
              "max": 123,
              "min": 123,
              "selected": true
            }
          ],
          "calculation": [
            {
              "evidence_refs": [
                "<string>"
              ],
              "id": "<string>",
              "text": "<string>",
              "contradicting_refs": [
                "<string>"
              ],
              "facet": "<string>",
              "origin": "deterministic",
              "stated_intention": false,
              "support": "supported"
            }
          ],
          "drivers": [
            {
              "evidence_ref": "<string>",
              "explanation": "<string>",
              "kind": "answer",
              "label": "<string>",
              "rank": 2,
              "strength": "major"
            }
          ],
          "evidence_ref": "<string>",
          "label": "<string>",
          "rules_counted": 123,
          "score": 123,
          "signals_counted": 123,
          "unanswered_excluded": 123,
          "aligned": true,
          "description": "<string>",
          "expected_band_label": "<string>"
        }
      ],
      "discussion": [
        {
          "detail": "<string>",
          "evidence_refs": [
            "<string>"
          ],
          "id": "<string>",
          "rank": 2,
          "reason": "<string>",
          "title": "<string>",
          "origin": "deterministic"
        }
      ],
      "evidence": [
        {
          "id": "<string>",
          "kind": "answer",
          "label": "<string>",
          "detail": "<string>",
          "diagnostics": {
            "ref": "<string>",
            "active_ms": 123,
            "axis": "<string>",
            "channel": "<string>",
            "clarifications": 123,
            "cohort_size": 123,
            "cutpoints": [
              123
            ],
            "input": "<string>",
            "max_possible": 123,
            "min_possible": 123,
            "normalized_impact": 123,
            "observed": 123,
            "points": 123,
            "quartile": 123,
            "raw_value": 123,
            "rejected_proposals": 123,
            "revisions": 123,
            "sensitivity": "<string>",
            "severity": "<string>",
            "source": "<string>",
            "status": "<string>",
            "text_length": 123,
            "value": "<unknown>"
          },
          "display": "<string>",
          "excerpt": {
            "speaker": "participant",
            "text": "<string>",
            "occurred_at": "2023-11-07T05:31:56Z"
          },
          "revised": false,
          "section_title": "<string>",
          "source": "<string>",
          "state": "<string>",
          "stated_intention": false,
          "supports": [
            "<string>"
          ],
          "withheld": false
        }
      ],
      "insights": {
        "status": "pending",
        "attempts": 123,
        "dropped_claims": 123,
        "generated_at": "2023-11-07T05:31:56Z",
        "generation": "<string>",
        "last_error": "<string>",
        "model": "<string>",
        "next_attempt_at": "2023-11-07T05:31:56Z",
        "notice": "<string>"
      },
      "overview": {
        "headline": {
          "evidence_refs": [
            "<string>"
          ],
          "id": "<string>",
          "text": "<string>",
          "contradicting_refs": [
            "<string>"
          ],
          "facet": "<string>",
          "origin": "deterministic",
          "stated_intention": false,
          "support": "supported"
        },
        "how_scores_work": "<string>",
        "status": "<string>",
        "summary": [
          {
            "evidence_refs": [
              "<string>"
            ],
            "id": "<string>",
            "text": "<string>",
            "contradicting_refs": [
              "<string>"
            ],
            "facet": "<string>",
            "origin": "deterministic",
            "stated_intention": false,
            "support": "supported"
          }
        ],
        "matched_dimensions": 123,
        "primary_label": "<string>",
        "total_dimensions": 123
      },
      "profile": [
        {
          "fact_refs": [
            "<string>"
          ],
          "gap_refs": [
            "<string>"
          ],
          "id": "<string>",
          "label": "<string>",
          "status": "evidenced",
          "summary": {
            "evidence_refs": [
              "<string>"
            ],
            "id": "<string>",
            "text": "<string>",
            "contradicting_refs": [
              "<string>"
            ],
            "facet": "<string>",
            "origin": "deterministic",
            "stated_intention": false,
            "support": "supported"
          },
          "narrative": [
            {
              "evidence_refs": [
                "<string>"
              ],
              "id": "<string>",
              "text": "<string>",
              "contradicting_refs": [
                "<string>"
              ],
              "facet": "<string>",
              "origin": "deterministic",
              "stated_intention": false,
              "support": "supported"
            }
          ]
        }
      ],
      "scenarios": {
        "collected": true,
        "configured": true,
        "items": [
          {
            "excerpt_refs": [
              "<string>"
            ],
            "id": "<string>",
            "prompt": "<string>",
            "related_refs": [
              "<string>"
            ],
            "stated_intention": true,
            "status": "explored",
            "summary": {
              "evidence_refs": [
                "<string>"
              ],
              "id": "<string>",
              "text": "<string>",
              "contradicting_refs": [
                "<string>"
              ],
              "facet": "<string>",
              "origin": "deterministic",
              "stated_intention": false,
              "support": "supported"
            },
            "follow_ups_used": 123,
            "gap_ref": "<string>",
            "insights": [
              {
                "evidence_refs": [
                  "<string>"
                ],
                "id": "<string>",
                "text": "<string>",
                "contradicting_refs": [
                  "<string>"
                ],
                "facet": "<string>",
                "origin": "deterministic",
                "stated_intention": false,
                "support": "supported"
              }
            ],
            "required": true,
            "section_title": "<string>"
          }
        ],
        "note": {
          "evidence_refs": [
            "<string>"
          ],
          "id": "<string>",
          "text": "<string>",
          "contradicting_refs": [
            "<string>"
          ],
          "facet": "<string>",
          "origin": "deterministic",
          "stated_intention": false,
          "support": "supported"
        }
      },
      "versions": {
        "builder": 123,
        "evidence": 123,
        "origin": "completion",
        "report_schema": "<string>",
        "built_at": "2023-11-07T05:31:56Z",
        "bundle_fingerprint": "<string>",
        "bundle_id": "<string>",
        "engine_fingerprint": "<string>",
        "generation": "<string>",
        "pack_fingerprint": "<string>",
        "template_content_hash": "<string>",
        "template_revision": 123,
        "template_version_id": "<string>"
      }
    },
    "confidence": {},
    "coverage": {},
    "guardrail_conflicts": [
      {}
    ],
    "primary_metric": {},
    "report": {},
    "sub_scores": [
      {}
    ],
    "unanswered_concepts": [
      "<string>"
    ]
  }
}

{
  "detail": {
    "code": "<string>",
    "message": "<string>",
    "context": {},
    "request_id": "<string>"
  }
}

{
  "detail": {
    "code": "<string>",
    "message": "<string>",
    "context": {},
    "request_id": "<string>"
  }
}

{
  "detail": {
    "code": "<string>",
    "message": "<string>",
    "context": {},
    "request_id": "<string>"
  }
}

{
  "detail": {
    "code": "<string>",
    "message": "<string>",
    "context": {},
    "request_id": "<string>"
  }
}

{
  "detail": {
    "code": "<string>",
    "message": "<string>",
    "context": {},
    "request_id": "<string>"
  }
}