Introduction
...
Project Story Categories (aka Survey campaign) (Not merged)
Desc: get all project_story_categories
url: /project_story_categories
params: default params
...
Endpoint:
GET /api/v2/project_story_categories?page=2&per_page=2Authentication: 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
| Code Block | ||
|---|---|---|
| ||
{
"page": 1,
"page_size": 10,
"page_count": 2,
"total_count": 15,
"data": [
{
"id": 16163,
"project_id": 3951,
"story_category_id": 6068,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": true,
"display_respondent_name": false,
"created_at": "2023-10-11T14:18:05.228+01:00",
"updated_at": "2023-10-11T14:18:05.228+01:00"
},
{
"id": 16165,
"project_id": 3951,
"story_category_id": 6071,
"allow_sign_out_story": true,
"is_stopped": false,
"display_intro_message": false,
"display_respondent_name": false,
"created_at": "2023-10-11T14:57:34.104+01:00",
"updated_at": "2023-10-12T07:28:50.760+01:00"
},
{
"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"
},
{
"id": 16171,
"project_id": 3951,
"story_category_id": 6074,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": true,
"display_respondent_name": false,
"created_at": "2023-10-25T07:59:34.535+01:00",
"updated_at": "2023-10-25T07:59:34.535+01:00"
},
{
"id": 16173,
"project_id": 3954,
"story_category_id": 6076,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": true,
"display_respondent_name": false,
"created_at": "2023-10-27T07:59:58.128+01:00",
"updated_at": "2023-10-27T07:59:58.128+01:00"
},
{
"id": 16175,
"project_id": 3951,
"story_category_id": 6078,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": false,
"display_respondent_name": false,
"created_at": "2023-11-01T12:17:40.598+00:00",
"updated_at": "2023-11-01T12:17:40.598+00:00"
},
{
"id": 16177,
"project_id": 3954,
"story_category_id": 6080,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": null,
"display_respondent_name": null,
"created_at": "2023-11-07T10:59:23.113+00:00",
"updated_at": "2023-11-07T11:08:37.409+00:00"
},
{
"id": 16178,
"project_id": 3954,
"story_category_id": 6081,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": null,
"display_respondent_name": null,
"created_at": "2023-11-16T06:56:15.498+00:00",
"updated_at": "2023-11-16T07:18:20.778+00:00"
},
{
"id": 16179,
"project_id": 3954,
"story_category_id": 6073,
"allow_sign_out_story": false,
"is_stopped": false,
"display_intro_message": null,
"display_respondent_name": null,
"created_at": "2023-11-22T10:26:19.518+00:00",
"updated_at": "2023-11-22T10:27:51.882+00:00"
}
]
} |