Get analysis result
- 9 Minutes to read
- Print
- DarkLight
Get analysis result
- 9 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback!
Get
/analysis-result/{calculationId}
Retrieve the analysis data.
Security
OAuth
FlowClient Credentials
Token URLhttps://intelligence.eu.mapp.com/analytics/api/oauth/token
Scopes:
mapp.intelligence-apiUse intelligence APIs
Path parameters
calculationId
stringRequired
ID of the calculated Data
Responses
200
OK
Simple analysis result
{
"calculationDataType": "RAW_DATA",
"rows": [
[
"20210826",
"Unknown",
"7",
"8",
"100",
"30",
"85.71428571428571",
""
],
[
"20210826",
"Microsoft",
"3",
"30",
"0",
"38.333333333333336",
"0",
""
],
[
"20210826",
"Apple",
"3",
"15",
"0",
"33",
"0",
"3"
],
[
"20210826",
"",
"13",
"53",
"53.84615384615385",
"32.61538461538461",
"46.15384615384615",
"3"
],
[
"20210827",
"Unknown",
"7",
"8",
"100",
"30",
"85.71428571428571",
""
],
[
"20210827",
"Microsoft",
"3",
"30",
"0",
"38.333333333333336",
"0",
""
],
[
"20210827",
"Apple",
"3",
"14",
"0",
"32.666666666666664",
"0",
"3"
],
[
"20210827",
"",
"13",
"52",
"53.84615384615385",
"32.53846153846154",
"46.15384615384615",
"3"
],
[
"20210828",
"Unknown",
"8",
"8",
"100",
"30",
"100",
""
],
[
"20210828",
"Microsoft",
"7",
"40",
"0",
"48.714285714285715",
"14.285714285714285",
""
],
[
"20210828",
"Apple",
"3",
"15",
"0",
"33",
"0",
"3"
],
[
"20210828",
"",
"18",
"63",
"44.44444444444444",
"37.77777777777778",
"50",
"3"
],
[
"20210829",
"Unknown",
"6",
"8",
"100",
"30",
"83.33333333333334",
""
],
[
"20210829",
"Apple",
"3",
"30",
"0",
"35.333333333333336",
"0",
"3"
],
[
"20210829",
"Microsoft",
"2",
"11",
"0",
"36",
"0",
""
],
[
"20210829",
"",
"11",
"49",
"54.54545454545454",
"32.54545454545455",
"45.45454545454545",
"3"
],
[
"20210830",
"Unknown",
"8",
"8",
"100",
"30",
"100",
""
],
[
"20210830",
"Apple",
"3",
"15",
"0",
"33.333333333333336",
"0",
"3"
],
[
"20210830",
"Microsoft",
"2",
"24",
"0",
"37.5",
"0",
""
],
[
"20210830",
"",
"13",
"47",
"61.53846153846154",
"31.923076923076923",
"61.53846153846154",
"3"
],
[
"20210831",
"Unknown",
"7",
"8",
"100",
"30",
"85.71428571428571",
""
],
[
"20210831",
"Microsoft",
"4",
"31",
"0",
"45",
"25",
""
],
[
"20210831",
"Apple",
"3",
"15",
"0",
"32.666666666666664",
"0",
"3"
],
[
"20210831",
"",
"14",
"54",
"50",
"34.857142857142854",
"50",
"3"
],
[
"20210901",
"Unknown",
"8",
"8",
"100",
"30",
"100",
""
],
[
"20210901",
"Apple",
"5",
"39",
"0",
"33.4",
"0",
"5"
],
[
"20210901",
"Microsoft",
"2",
"4",
"0",
"80",
"50",
""
],
[
"20210901",
"",
"15",
"51",
"53.333333333333336",
"37.8",
"60",
"5"
],
[
"",
"",
"97",
"369",
"52.57731958762887",
"34.58762886597938",
"51.546391752577314",
"23"
]
],
"rowCount": "29",
"rowCountTotal": "21",
"headers": [
{
"alias": "time_id_categories_t_year_month_day|0",
"arrangeType": "time_id_categories_t_year_month_day",
"sumPositions": [
"28"
],
"pivotGroups": [
"0",
"4",
"8",
"12",
"16",
"20",
"24",
"28"
],
"name": "time_days",
"metric": false,
"dimension": true,
"sortIndex": "0",
"sortDirection": "ASCENDING"
},
{
"alias": "platform_vendor|0",
"arrangeType": "platform_vendor",
"sumPositions": [
"3",
"7",
"11",
"15",
"19",
"23",
"27",
"28"
],
"name": "os_vendor",
"metric": false,
"dimension": true
},
{
"alias": "visits|0",
"arrangeType": "visits",
"name": "visits",
"metric": true,
"dimension": false
},
{
"alias": "page_impressions|0",
"arrangeType": "page_impressions",
"name": "pages_pageImpressions",
"metric": true,
"dimension": false
},
{
"alias": "predefined_formula_new_visitor_rate|0",
"arrangeType": "predefined_formula_new_visitor_rate",
"name": "visits_newShare",
"metric": true,
"dimension": false
},
{
"alias": "predefined_formula_avg_visit_duration|0",
"arrangeType": "predefined_formula_avg_visit_duration",
"name": "visit_duration_avg",
"metric": true,
"dimension": false
},
{
"alias": "predefined_formula_bounce_rate|0",
"arrangeType": "predefined_formula_bounce_rate",
"name": "visits_bounceRate",
"metric": true,
"dimension": false
},
{
"alias": "visits|1",
"arrangeType": "visits",
"name": "visits",
"metric": true,
"dimension": false
}
],
"columnCount": "8",
"warnings": [],
"timerange": [
"2021-08-26T00:00:00.000+0200",
"2021-09-02T00:00:00.000+0200"
],
"timestamp": "2021-09-02T09:15:43.567+0200"
}object
calculationDataType
string
DataType returned
Valid values[ "RAW_DATA", "RAW_DATA_SAMPLING" ]
rows
Array of array
Array of rows
Array
Array of values following the strict order of the headers
rowCount
integer
Number of rows returned.
rowCountTotal
integer
Number of rows in the whole resultSet wihtout subtotals
headers
Array of object
object
name
string
Name of the Dimension or Metric
alias
string
Generated unique identifier of the column in the analysis.
arrangeType
string
Mapp identifier of the Dimension or Metric
metric
boolean
Indicates if column is a metric
dimension
boolean
Indicates if column is a dimension
sumPositions
Array of integer
Indicates which rows contains a (sub)total value
integer
pivotGroups
Array of integer
Indicates which rows contains a grouping row
integer
sortIndex
integer
Indicates order of sorting when there is more than one sorting column. (starting from 0)
sortDirection
string
Possible sorting directions
Valid values[ "ASCENDING", "DESCENDING" ]
columnCount
integer
Number of columns
warnings
Array of object (Warning)
Array of warnings occurred during calculation
object
name
string
Each warnings has specific properties described in following table:
| Warning | Description | Relevant parameters |
|---|---|---|
| FilterLogicalCubeMismatch | At least one filter is ignored due to incompatibily with Dimensions and Metrics used. | List of incomptible filter objects in names array. |
| InvalidMetricContext | Metric used in an invalid context. | List of metric with invalid context in aliases array. |
| SortingEnforced | Sorting criteria has been added automatically | List of objects that were sorted automatically in aliases array. |
| NoSortingDefined | Sorting criteria is required for some dimensions. | List of dimensions requiring a sorting in names array. |
| SortingLimitExceeded | 3 sorting criteria are allowed. All additional sorting criteria have been omitted. | List of columns ignored for sorting in aliases array. |
| SortingRemoved | A requested sorting criteria has been removed | List of objects that were removed automatically in aliases array. |
| TodayRemoved | Today date has been removed from calculation time range because the selected datasource does not contain it. | daysInDataSource, todayDate |
Valid values[ "FilterLogicalCubeMismatch", "InvalidMetricContext", "SortingEnforced", "NoSortingDefined", "SortingLimitExceeded", "SortingRemoved", "TodayRemoved" ]
parameters
object
arrangeTypes
Array of string
List of internal object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
aliases
Array of string
List of columns aliases that corresponds to the error. See Result Header alias property.
string
names
Array of string
List of object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
daysInDataSource
string
Number of days in the datasource which is beeing cut
todayDate
string
Date of the day being cut
timerange
Array of string
time range boundaries with format yyyy-MM-dd HH:mm:ss
Min items2
Max items2
string
timestamp
string (date-time)
Timestamp of the calculation
403
No permission to execute operation
AnalysisNotFound
Invalid Token
{
"title": "Invalid Token",
"status": 403,
"detail": "Token not valid",
"statusCode": "INVALID_TOKEN"
}object
status
integer
HTTP Status Code
statusCode
string
Specific Mapp Error Code
title
string
Short description of the problem
detail
string
Detailed informations about the problem
errors
Array of object (Error)
object
name
string
Each error has specific properties described in following table:
| Error | Description | Relevant parameters |
|---|---|---|
| UnmappedName | At least one object name cannot be found. | List of objects not found in names array. |
| PivotIncompatibleMetric | Metric not usable in Pivot detected. | List of incompatible Metrics in names array. |
| PivotIncompatibleDimension | Dimension not usable in Pivot detected. | List of incompatible Dimensions in names array. |
| AnalysisLogicalCubeMismatch | All Dimensions and Metrics are not compatible. | List of incompatible objects in names array. |
| InvalidSortingCriteria | Sorting is applied on a non-sortable object. | List of invalid sorted objects in names array. |
| TimeFilterMissing | Each query must have a minimum of one Time Filter. | N/A |
| InvalidSegmentNoneContainer | A segment container has context set to NONE but either its connector is not set to AND or its inOrNotIn property is not set to IN. | N/A |
Valid values[ "UnmappedName", "PivotIncompatibleMetric", "PivotIncompatibleDimension", "AnalysisLogicalCubeMismatch", "InvalidSortingCriteria", "TimeFilterMissing", "InvalidSegmentNoneContainer" ]
parameters
object
arrangeTypes
Array of string
List of internal object names (dimension, metrics, filter, ...) that corresponds to the error.
string
aliases
Array of string
List of columns aliases that corresponds to the error. See Result Header alias property.
string
names
Array of string
List of object names (dimension, metrics, filter, ...) that corresponds to the error.
string
warnings
Array of object (Warning)
object
name
string
Each warnings has specific properties described in following table:
| Warning | Description | Relevant parameters |
|---|---|---|
| FilterLogicalCubeMismatch | At least one filter is ignored due to incompatibily with Dimensions and Metrics used. | List of incomptible filter objects in names array. |
| InvalidMetricContext | Metric used in an invalid context. | List of metric with invalid context in aliases array. |
| SortingEnforced | Sorting criteria has been added automatically | List of objects that were sorted automatically in aliases array. |
| NoSortingDefined | Sorting criteria is required for some dimensions. | List of dimensions requiring a sorting in names array. |
| SortingLimitExceeded | 3 sorting criteria are allowed. All additional sorting criteria have been omitted. | List of columns ignored for sorting in aliases array. |
| SortingRemoved | A requested sorting criteria has been removed | List of objects that were removed automatically in aliases array. |
| TodayRemoved | Today date has been removed from calculation time range because the selected datasource does not contain it. | daysInDataSource, todayDate |
Valid values[ "FilterLogicalCubeMismatch", "InvalidMetricContext", "SortingEnforced", "NoSortingDefined", "SortingLimitExceeded", "SortingRemoved", "TodayRemoved" ]
parameters
object
arrangeTypes
Array of string
List of internal object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
aliases
Array of string
List of columns aliases that corresponds to the error. See Result Header alias property.
string
names
Array of string
List of object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
daysInDataSource
string
Number of days in the datasource which is beeing cut
todayDate
string
Date of the day being cut
404
Entity not found
AnalysisNotFound
CorrelationId does not exist
{
"title": "Analysis not found",
"status": 404,
"detail": "Analysis not found",
"statusCode": "ANALYSIS_NOT_FOUND"
}object
status
integer
HTTP Status Code
statusCode
string
Specific Mapp Error Code
title
string
Short description of the problem
detail
string
Detailed informations about the problem
errors
Array of object (Error)
object
name
string
Each error has specific properties described in following table:
| Error | Description | Relevant parameters |
|---|---|---|
| UnmappedName | At least one object name cannot be found. | List of objects not found in names array. |
| PivotIncompatibleMetric | Metric not usable in Pivot detected. | List of incompatible Metrics in names array. |
| PivotIncompatibleDimension | Dimension not usable in Pivot detected. | List of incompatible Dimensions in names array. |
| AnalysisLogicalCubeMismatch | All Dimensions and Metrics are not compatible. | List of incompatible objects in names array. |
| InvalidSortingCriteria | Sorting is applied on a non-sortable object. | List of invalid sorted objects in names array. |
| TimeFilterMissing | Each query must have a minimum of one Time Filter. | N/A |
| InvalidSegmentNoneContainer | A segment container has context set to NONE but either its connector is not set to AND or its inOrNotIn property is not set to IN. | N/A |
Valid values[ "UnmappedName", "PivotIncompatibleMetric", "PivotIncompatibleDimension", "AnalysisLogicalCubeMismatch", "InvalidSortingCriteria", "TimeFilterMissing", "InvalidSegmentNoneContainer" ]
parameters
object
arrangeTypes
Array of string
List of internal object names (dimension, metrics, filter, ...) that corresponds to the error.
string
aliases
Array of string
List of columns aliases that corresponds to the error. See Result Header alias property.
string
names
Array of string
List of object names (dimension, metrics, filter, ...) that corresponds to the error.
string
warnings
Array of object (Warning)
object
name
string
Each warnings has specific properties described in following table:
| Warning | Description | Relevant parameters |
|---|---|---|
| FilterLogicalCubeMismatch | At least one filter is ignored due to incompatibily with Dimensions and Metrics used. | List of incomptible filter objects in names array. |
| InvalidMetricContext | Metric used in an invalid context. | List of metric with invalid context in aliases array. |
| SortingEnforced | Sorting criteria has been added automatically | List of objects that were sorted automatically in aliases array. |
| NoSortingDefined | Sorting criteria is required for some dimensions. | List of dimensions requiring a sorting in names array. |
| SortingLimitExceeded | 3 sorting criteria are allowed. All additional sorting criteria have been omitted. | List of columns ignored for sorting in aliases array. |
| SortingRemoved | A requested sorting criteria has been removed | List of objects that were removed automatically in aliases array. |
| TodayRemoved | Today date has been removed from calculation time range because the selected datasource does not contain it. | daysInDataSource, todayDate |
Valid values[ "FilterLogicalCubeMismatch", "InvalidMetricContext", "SortingEnforced", "NoSortingDefined", "SortingLimitExceeded", "SortingRemoved", "TodayRemoved" ]
parameters
object
arrangeTypes
Array of string
List of internal object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
aliases
Array of string
List of columns aliases that corresponds to the error. See Result Header alias property.
string
names
Array of string
List of object names (dimension, metrics, filter, ...) that corresponds to the warning.
string
daysInDataSource
string
Number of days in the datasource which is beeing cut
todayDate
string
Date of the day being cut
Was this article helpful?