Changes (API)

Owned by Matt Kepple
Last updated: May 23, 2022
3 min read

There are two types of Change:

  • Activity

  • Participation

API Documentation

Changes

Desc: Get all changes

url: /changes

params: default params

response example: default response example (multiple records)

Front-end documentation

Changes are among the set of things we call Progress Trackers in the front-end.

  • Another way to think of a Change is as a custom KPI or metric created by a user.

  • This custom KPI can be added to one or more projects and then tracked by creating stories which tag that KPI or metric in them and log a numerical or qualitative value against that KPI or metric.

Example

  • A custom KPI, i.e. a Change is Children Rehomed. Imagine that an orphanage is using Makerble and they want to track the number of children that have been rehomed

  • The orphanage organisation might have three orphanages, called

    • Blue Orphanage

    • Red Orphanage

    • Yellow Orphanage

  • Each of these orphanages would be a project on Makerble

  • In order to track the number of Children Rehomed at each of the orphanages, the charity will add the Children Rehomed custom KPI to each of the projects.

  • A Project Change is the term for a custom KPI added to a project. So now that the custom KPI has been added to these three projects, the Project Changes table will be updated with three new entries

  • In order to then track the number of children being rehomed over time, stories need to be created. Each story has a fixed date attached to it, this is the actual created date field.

  • A story can only be linked to a single project but it can contain several changes

  • When a story is created that includes some Change, the Story Changes table is updated with new records

  • So for example, if I create a story on 1st August 2021 about Red Orphanage and say that 20 children were rehomed, the database will record StoryChange of 20 against the Children Rehomed Change and within the Red Orphanage project

  • When you go to a project page, the five column section shows you the total StoryChange that has been recorded for each Project Change, i.e. for each custom KPI that has been added to that project. Custom KPIs that are Changes appear in only the first TWO columns. This is because they have one of two stages, either the Activity Metrics stage (the 1st column) or the Participation Metrics stage (the 2nd column). Columns 3, 4 and 5 are reserved for Outcomes and their associated Indicators.

  • The charity might also choose to add a target for each orphanage, e.g.

    • in Blue Orphanage we want to rehome 20 children

    • in Red Orphanage we want to rehome 50 children

    • in Yellow Orphanage we want to rehome 100 children

  • These targets are also saved within the Project Change table. The progress bar for each Change is therefore based on the total StoryChange as a percentage of the Project Change. (When there is no target, i.e. the Project Change is zero, the progress bar shows as full from the outset)