Story Indicator Beneficiary (API)
- Matt Kepple
API Documentation
Story Indicator Beneficiary
Desc: Get all story indicator beneficiaries
url: /story_indicator_beneficiaries
params: default params
additional params:
story_id: 123 (default null)
response example: default response example (multiple records)
What is a Story Indicator Beneficiary record?
Story Indicator Beneficiary records are 1 of 3 ways to associate a beneficiary with a story.
The other two are Story Change Beneficiary records and Story Beneficiary records. (Note that a single story can contain all three types of record.)
What is a Story?
A story is the main data format on Makerble
Survey responses are saved as stories
Case notes are saved as stories
All progress data on Makerble is saved as a story
Find out more by reading about the Stories API
What is a Beneficiary?
Makerble is a CRM System (Customer Relationship Management)
Beneficiary is the term that is used to store each customer. In the front-end we call them Contacts.
Find out more by reading about the Beneficiaries API
A beneficiary can be tagged in many stories
Every story that a beneficiary is tagged in will appear on the Beneficiary’s Timeline - the purple section below (See the Contact Profile Page)
What is an Indicator?
An indicator is a type of question that appears in a survey
A beneficiary’s answer to a survey question will be saved as story indicator beneficiary data if the question is of the Indicator type. (There are other types of question: Custom Fields, Changes and default questions)
There are three types of Indicator:
Binary Indicator (Achievement Tracker in the front-end)
Scale Indicator (Multiple Choice Tracker in the front-end)
Value Indicator (Numerical Progress Tracker in the front-end)
Every indicator must be part of at least one Outcome
When an indicator is linked to an outcome, an Outcome Indicator record is created
For example, a Scale indicator
For example when logging that a beneficiary’s answer to a multiple choice question (Scale Indicator) was “Strongly Disagree” on a five point scale where the other Sub Ratios in the Ratio Set were
Strongly Disagree
Disagree
No Opinion
Agree [described below]
Strongly Agree
Example from the front-end
The Orange Box describes the Story Indicator data and within that there are FIVE story indicator beneficiary records that are created
Watch the explanation video: https://www.loom.com/share/642b80b9abd84d2e8d04e1a22269c76d
Screenshot of 1 of the 5 story indicator beneficiary records in the Admin Panel that were created when this story was made