Introduction

• Story Categories are called Surveys in the front-end

• A survey can only be used once it has been added to a project

• Once a Survey has been added to a project, the Project Story Category is referred to in the front-end as a Survey Campaign

• A Survey Campaign page allows the user to deploy the survey (to beneficiaries in that particular project) and view results (i.e. see the stories that were created using that Story Category)

API Documentation

Project Story Categories (aka Survey campaign) (Not merged)

• Endpoint: GET /api/v2/project_story_categories?page=2&per_page=2

• Authentication: Requires valid authentication token

• Response Format: JSON

• Query Parameters:

  • page (integer, optional): The page number for pagination (default is 1).

  • per_page (integer, optional): The number of choices per page (default is 10).

Response Attributes

• page (integer): The current page number.

• page_size (integer): The number of project story categories per page.

• page_count (integer): The total number of pages.

• total_count (integer): The total number of project story categories.

• data (array of objects): List of project story categories.

  • id (integer): The unique identifier for the project story category.

  • project_id (integer): The ID of the associated project.

  • story_category_id (integer): The ID of the associated story category.

  • allow_sign_out_story (boolean): Indicates whether signing out from the story is allowed.

  • is_stopped (boolean): Indicates whether the project story category is stopped or active.

  • display_intro_message (boolean): Indicates whether the intro message should be displayed.

  • display_respondent_name (boolean): Indicates whether the respondent's name should be displayed.

  • created_at (string, ISO 8601 datetime): The timestamp when the project story category was created.

  • updated_at (string, ISO 8601 datetime): The timestamp when the project story category was last updated.

Example

GET https://makerble.com/api/v2/project_story_categories?page=2&per_page=2

Response

{
    "page": 2,
    "page_size": 2,
    "page_count": 8,
    "total_count": 15,
    "data": [
        {
            "id": 16167,
            "project_id": 3951,
            "story_category_id": 6072,
            "allow_sign_out_story": false,
            "is_stopped": false,
            "display_intro_message": true,
            "display_respondent_name": false,
            "created_at": "2023-10-13T09:21:47.215+01:00",
            "updated_at": "2023-10-13T09:21:47.215+01:00"
        },
        {
            "id": 16169,
            "project_id": 3951,
            "story_category_id": 6073,
            "allow_sign_out_story": false,
            "is_stopped": false,
            "display_intro_message": true,
            "display_respondent_name": false,
            "created_at": "2023-10-20T11:27:18.676+01:00",
            "updated_at": "2023-10-20T11:27:18.676+01:00"
        }
    ]
}