Get the collection of prompts and their respective definitions from a report instance. This endpoint will return data only when the report instance has prompt which need to be answered.
GET {{baseUrl}}/api/reports/:reportId/instances/:instanceId/prompts
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
closed | boolean | Prompt status, true means get closed prompt, false means get open prompt | |
fields | null | Comma-separated, top-level field whitelist that allows the client to selectively retrieve part of the response model. If specified, extra filtering is applied, and for top-level object (if root model is an array, each array element), only the listed fields are kept in the response. For example, "id,elements" keeps only the "id" field and whole "elements" array field, omitting all other fields in the top-level response model. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
X-MSTR-AuthToken | string | (Required) Authorization token | |
X-MSTR-ProjectID | string | (Required) Project ID |
RESPONSES
status: OK
[{"id":"659E3A98429055ABE3DC448228E508CB","key":"659E3A98429055ABE3DC448228E508CB@0@10","name":"Select a Category","title":"Choose from all elements of 'Category'.","type":"ELEMENTS","required":true,"closed":false,"source":{"name":"Category","id":"8D679D3711D3E4981000E787EC6DE8A4","type":12},"defaultAnswer":[],"answers":[{"id":"h2;8D679D3711D3E4981000E787EC6DE8A4","name":"Electronics"},{"id":"h3;8D679D3711D3E4981000E787EC6DE8A4","name":"Movies"}]},{"id":"90DB00A9445D021DFD41519A90EE8DD3","key":"90DB00A9445D021DFD41519A90EE8DD3@0@10","name":"Above Revenue Goals","title":"Above Revenue Goals","type":"VALUE","required":true,"closed":false,"answers":500000,"defaultAnswer":500000,"dataType":"NUMERIC"},{"id":"89F6E2A14B288D9C216BB2AD3AB69098","key":"89F6E2A14B288D9C216BB2AD3AB69098@0@10","name":"Below Revenue Goals","title":"Below Revenue Goals","type":"VALUE","required":true,"closed":false,"answers":250000,"defaultAnswer":250000,"dataType":"NUMERIC"}]