Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

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?

...

  • There are three ways to associate a beneficiary with a story

    • Tagging the beneficiary directly in the story; this creates a Story Beneficiary recordTagging the beneficiary to progress towards a Change (metric), this creates a Story _Change_ Beneficiary record. For example when logging that a beneficiary attended a session whereby the metric is Sessions Attended

    • 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

      and
        • Agree [described below]

Watch the walkthrough

        • 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

Explanation

...

  • There are only two three types of Change metric Indicator:

    • Activity Change

    • Participation Change

  • This front-end documentation on Stages the different types of custom metrics that exist on Makerble; Changes, Outcomes and Indicators

  • When either an Activity Change (custom KPI) or Participation Change (custom KPI) is included within a story, it generates Story Change records

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)

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

    Image Added
  • 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

    Image Added

Related articles