API Documentation

Story Indicator Beneficiary

Desc: Get all story indicator beneficiaries

url: /story_indicator_beneficiaries

...

What is a Story Indicator Beneficiary record?

• There are three Story Indicator Beneficiary records are 1 of 3 ways to associate a beneficiary with a story

  • Tagging the beneficiary directly in the story; this creates a Story Beneficiary record

  • Tagging the beneficiary to progress towards an Indicator (metric), this creates a Story_Indicator_Beneficiary record.

    • 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

Rules

• Story Change Beneficiary data can only apply to a Participation Change, not an Activity Change

• One of the restrictions with Activity Change is that beneficiaries cannot be tagged in Story Change Beneficiary data for an Activity Change

...

• .

  • 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)

  Image Added

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

...