Versions Compared

Key

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

Introduction

...

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

...

  • 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

...