GetReportData
Get report data
Description
Obtain the results of a data report
Method
GET
Request URL Format
/api/v0/applications/:app-id/reports/:report-id
Query Params
per_page : Number of items per page
page : Number of pages
include_date_at: If true, the creation and modification dates are included in the search results. The creation and modification dates of the data specified as the data source will be included in the results. (When merging related parties, the creation and modification dates of the related items are not included.)
include_lookups : If true, even data of the database reference type Item is included.
include_item_ref : If true, the ID (d_id, i_id,rev_no) information of the item to which the field refers can be obtained
return_number_value : "include_lookups": If you specify true when true, the numeric type data of the referenced Item is output as Number (by default, the number value is returned as a string ("123"))
return_id_value_results : Specify true if you want to include ID and Value values related to choice type, status, and user in the search results.
return_count_only : Only totalItems information is returned. report_results will be null.
return_utc_datetime: For date-type fields, the return value is returned in UTC time (ISO format). However, if this setting is turned on in the HexabaseUI report settings, UTC is used regardless of the flag specification. This setting is valid only for the date type (not the Datetime type).
omit_total_items : Omit totalItems. (Omitting the count of the number of items works faster.)
total_count_timeout_sec : Specifies the number of timeout seconds to get totalItems. If the specified number of seconds is exceeded, the acquisition of totalItems is omitted (-1 is changed). default: 60s
data_result_timeout_sec : You can specify the number of timeout seconds for getting report_results. If timeout occurs, report_results will be omitted (null). default:60s
omit_fields_data : The "report_fields" part can be omitted from the obtained results (to reduce the amount of data when report_fields information is not needed).
format: Optional. If "csv" is specified, output is in CSV format.
Request URL Sample
GET https://api.xxx.com/api/v0/applications/APP_ID/reports/REPORT_ID?per_page=5&page=1
Response Sample
- If the display ID (display_id) is specified in the output field, report_result will use display_id.
If format="csv"
NOTE,TITLE,CATEGORY,STATUS,NUM,DUE_DATE
B,タスクＣ,B,New,0,2016/01/01
B,タスクＣ,案件（明細あり）,B,In Review,0,2016/01/01
B,,B,New,0,2016/01/01
B,１１１新規起票,B,New,0,2016/01/01
B,タスクB,B,New,0,2016/01/01
If format is omitted (json format)
{
"error": ""
"report_title": "SimpleJoin", // Report name
"totalItems": 40932, // Number of all data
"item_index_from": 0, // First index number of result data
"item_index_to": 4, // Last Index number of the result data
"report_results": [ // Acquisition data
{
"NOTE": "B",
"TITLE": "タスクC",
"CATEGORY": "B",
"STATUS": "New",
"NUM": 0,
"DUE_DATE": "2016/01/01",
"items": [ // In the case of a summary report, the ID of the corresponding Item and Datastore included in the summary result is included.
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2ff0"
},
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2ff2"
}
],
"i_id": "5f267f1628dc5c6988bc2fef" // For non-aggregated reports, the ID of the relevant item is included
},
{
"NOTE": "B",
"TITLE": "案件（明細あり）",
"CATEGORY": "B",
"STATUS": "In Review",
"NUM": 0,
"DUE_DATE": "2016/01/01"
"items": [
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2ff1"
}
]
},
{
"NOTE": "B",
"TITLE": "",
"CATEGORY": "B",
"STATUS": "New",
"NUM": 0,,
"items": [
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2fef"
}
]
},
{
"NOTE": "B",
"TITLE": "１１１新規起票",
"CATEGORY": "B",
"STATUS": "New",
"NUM": 0,,
"items": [
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2fee"
}
]
},
{
"NOTE": "B",
"TITLE": "タスクB",
"CATEGORY": "B",
"STATUS": "New",
"NUM": 0,
"DUE_DATE": "2016/01/01",
"items": [
{
"d_id": "5f267f1028dc5c6988bc2fe0",
"i_id": "5f267f1628dc5c6988bc2fbb"
}
]
}
],
"report_fields": [ // Field information of the acquired report
{
"title": "Title",
"rpf_id": "4a0b2f8a-f332-4579-a2d4-e9b5971d9e80",
"display_id" : "TITLE",
"data_type": "text",
"display_type": "",
"align": "",
"width": 235,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [],
"f_id": "5c69148384f4be344c2ff0f1",
"d_id": "5c69148384f4be1f241fedcd",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "Due Date",
"rpf_id": "b752bf7f-9f0d-4370-ac34-45b9be01453f",
"display_id" : "DUE_DATE",
"data_type": "date",
"display_type": "",
"align": "",
"width": 106,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [],
"f_id": "5c69148384f4be344c2ff0f5",
"d_id": "5c69148384f4be1f241fedcd",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "Category",
"rpf_id": "7b9db4bb-3516-4cd7-946a-97c1ddcdca2a",
"display_id" : "CATEGORY",
"data_type": "select",
"display_type": "text",
"align": "left",
"width": 94,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [
{
"cond_rpf_id": "7b9db4bb-3516-4cd7-946a-97c1ddcdca2a",
"condition": "eq",
"cond_type": "text",
"value": "B",
"bg_color": "#dcecf3",
"ft_color": "#165896",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
},
{
"cond_rpf_id": "7b9db4bb-3516-4cd7-946a-97c1ddcdca2a",
"condition": "eq",
"cond_type": "text",
"value": "C",
"bg_color": "#dcecf3",
"ft_color": "#165896",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
},
{
"cond_rpf_id": "7b9db4bb-3516-4cd7-946a-97c1ddcdca2a",
"condition": "eq",
"cond_type": "text",
"value": "A",
"bg_color": "#f4eaf3",
"ft_color": "#9e9e9e",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
}
],
"f_id": "5c6363ed84f4be7de0350452",
"d_id": "5c6363ed84f4be2550bfe8ff",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "Status",
"rpf_id": "85c15eca-1b7a-4423-9969-55f363efc4c1",
"display_id" : "STATUS",
"data_type": "status",
"display_type": "text",
"align": "left",
"width": 97,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [
{
"cond_rpf_id": "85c15eca-1b7a-4423-9969-55f363efc4c1",
"condition": "eq",
"cond_type": "text",
"value": "新規",
"bg_color": "#f9e9e9",
"ft_color": "#c01717",
"apply_row": true,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
},
{
"cond_rpf_id": "2d9bfd30-e194-4492-a93e-e6d0e4323685",
"condition": "eq",
"cond_type": "text",
"value": "",
"bg_color": "#f0f7df",
"ft_color": "#2a7850",
"apply_row": false,
"use_field_ref": true,
"value_rpf_id": "4552a666-508d-419c-ba99-7c9a16b24894",
"font_size": "small",
"font_style": "italic",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
}
],
"f_id": "5c6363ed84f4be7de0350453",
"d_id": "5c6363ed84f4be2550bfe8ff",
"merge_cells": false,
"hide": true,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "note",
"rpf_id": "4552a666-508d-419c-ba99-7c9a16b24894",
"display_id" : "NOTE",
"data_type": "textarea",
"display_type": "",
"align": "",
"width": 174,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [],
"f_id": "5c6459de84f4be4588a77288",
"d_id": "5c6363ed84f4be2550bfe8ff",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "Num",
"rpf_id": "8a20643b-fe36-45f1-bbd6-b2b6e4296a54",
"display_id" : "NUM",
"data_type": "number",
"display_type": "number",
"align": "right",
"width": 200,
"negative_sign_type": "triangle",
"num_format": "comma-separeted",
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [],
"f_id": "5c91f38a84f4be29540c4e9c",
"d_id": "5c6363ed84f4be2550bfe8ff",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": false
},
{
"title": "X",
"rpf_id": "X",
"data_type": "number",
"display_type": "number",
"align": "right",
"width": 104,
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [
{
"cond_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"condition": "eq",
"cond_type": "number",
"value": 1,
"bg_color": "#f8eadc",
"ft_color": "#d26c07",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"font_size": "big",
"font_style": "italic",
"font_weight": "bold",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
},
{
"cond_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"condition": "eq",
"cond_type": "number",
"value": "",
"bg_color": "#FFFFFF",
"ft_color": "#000000",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "num_format"
}
],
"f_id": "",
"d_id": "",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": true
},
{
"title": "Y",
"rpf_id": "Y",
"data_type": "number",
"display_type": "number",
"align": "right",
"width": 104,
"num_info": {
"prefix": "",
"suffix": "",
"no_comma": false
},
"conditions": [
{
"cond_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"condition": "eq",
"cond_type": "number",
"value": 1,
"bg_color": "#f8eadc",
"ft_color": "#d26c07",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"font_size": "big",
"font_style": "italic",
"font_weight": "bold",
"negative_sign_type": "normal",
"num_format": "comma-separeted"
},
{
"cond_rpf_id": "5ccad4b2-831a-4172-a91c-aa1f93ff107b",
"condition": "eq",
"cond_type": "number",
"value": "",
"bg_color": "#FFFFFF",
"ft_color": "#000000",
"apply_row": false,
"use_field_ref": false,
"value_rpf_id": "",
"font_size": "normal",
"font_style": "normal",
"font_weight": "normal",
"negative_sign_type": "normal",
"num_format": "num_format"
}
],
"f_id": "",
"d_id": "",
"merge_cells": false,
"hide": false,
"disable_search": false,
"use_integrated_report": false,
"is_cross_key": true
}
]
}