API Documentation

Story Change Beneficiary

Desc: Get all story change beneficiaries

url: /story_change_beneficiaries

params: default params

response example: default response example (multiple records)

What is a Story Change 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 record
- Tagging 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 [described below]
- 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

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

An Activity Change and a Participation Change are two examples of a Changes (API)
When either an Activity Change (custom KPI) or Participation Change (custom KPI) is included within a story, it generates Story Changes (API) records