Create report calculation query

Prev Next
Post
/report-query

Create multiple calculation queries, also known as a report.

Security
OAuth
FlowClient Credentials
Token URLhttps://intelligence.eu.mapp.com/analytics/api/oauth/token
Scopes:
mapp.intelligence-apiUse intelligence APIs
Body parameters
ANALYSIS
{
  "configuration": {
    "id": "3687",
    "title": "! !!  ANALYTICS-2295",
    "description": "",
    "timeFilter": {
      "arrangeType": "times_internal_day",
      "connector": "AND",
      "filterPredicate": "BETWEEN",
      "value1": "2022-10-15",
      "value2": "2023-12-28",
      "context": "NONE",
      "caseSensitive": false,
      "intern": false,
      "numberOfDays": "0"
    },
    "reportElements": [
      {
        "type": "TEXTBOX_DESCRIPTION",
        "id": "43942",
        "position": "0",
        "positionAsPoint": {
          "x": "0",
          "y": "0"
        },
        "width": "3",
        "height": "1",
        "reportId": "3687",
        "configJson": {}
      },
      {
        "type": "TEXTBOX_CONTENT_TABLE",
        "id": "43944",
        "position": "1",
        "positionAsPoint": {
          "x": "3",
          "y": "0"
        },
        "width": "3",
        "height": "1",
        "reportId": "3687",
        "configJson": {}
      },
      {
        "type": "ANALYSIS",
        "id": "43946",
        "position": "2",
        "positionAsPoint": {
          "x": "0",
          "y": "0"
        },
        "width": "3",
        "height": "78",
        "reportId": "3687",
        "configJson": {
          "predefinedContainer": {
            "filters": [],
            "containers": [],
            "combined": false
          },
          "title": "ThisareallyreallylongtrafficanalysistitleaimingtobreakthesidemenuUI",
          "realTime": false,
          "predefinedSegmentConnections": [],
          "columns": [
            {
              "arrangeType": "time_id_categories_t_year_month_day",
              "dataType": "NUMBER",
              "sortDirection": "ASCENDING",
              "title": "Days",
              "scope": "OBJECT",
              "context": "NONE",
              "visible": true,
              "dimension": true,
              "metric": false,
              "alias": "time_id_categories_t_year_month_day|0",
              "lowerLimit": "1",
              "upperLimit": "28",
              "sumValue": false,
              "predefinedSegmentConnections": []
            },
            {
              "arrangeType": "visits",
              "dataType": "NUMBER",
              "title": "Visits",
              "scope": "OBJECT",
              "context": "SESSION",
              "variant": "NORMAL",
              "visible": true,
              "dimension": false,
              "metric": true,
              "predefinedContainer": {
                "filters": [],
                "containers": [],
                "combined": false
              },
              "alias": "visits|0",
              "inTimeSeries": false,
              "chart": {
                "visible": true,
                "yAxis": "0"
              },
              "sumValue": false,
              "predefinedSegmentConnections": [],
              "columnPeriod": "ANALYSIS",
              "round": "-1",
              "roundConfig": {
                "override": false,
                "round": "2"
              }
            },
            {
              "arrangeType": "page_impressions",
              "dataType": "NUMBER",
              "title": "Page Impressions",
              "scope": "OBJECT",
              "context": "PAGE",
              "variant": "NORMAL",
              "visible": true,
              "dimension": false,
              "metric": true,
              "predefinedContainer": {
                "filters": [],
                "containers": [],
                "combined": false
              },
              "alias": "page_impressions|0",
              "inTimeSeries": false,
              "chart": {
                "visible": false,
                "yAxis": "0"
              },
              "sumValue": false,
              "predefinedSegmentConnections": [],
              "columnPeriod": "ANALYSIS",
              "round": "-1",
              "roundConfig": {
                "override": false,
                "round": "2"
              }
            },
            {
              "arrangeType": "predefined_formula_new_visitor_rate",
              "dataType": "NUMBER",
              "title": "New Visit Rate %",
              "metricDisplayType": "DISTRIBUTION",
              "dataVisual": "BARS",
              "scope": "OBJECT",
              "variant": "NORMAL",
              "visible": true,
              "dimension": false,
              "metric": true,
              "predefinedContainer": {
                "filters": [],
                "containers": [],
                "combined": false
              },
              "alias": "predefined_formula_new_visitor_rate|0",
              "inTimeSeries": false,
              "chart": {
                "visible": true,
                "yAxis": "1"
              },
              "sumValue": false,
              "predefinedSegmentConnections": [],
              "columnPeriod": "ANALYSIS",
              "round": "2",
              "roundConfig": {
                "override": false,
                "round": "2"
              }
            },
            {
              "arrangeType": "predefined_formula_avg_visit_duration",
              "dataType": "NUMBER",
              "title": "Visit Duration Avg",
              "metricDisplayType": "TIME",
              "dataVisual": "BARS",
              "scope": "OBJECT",
              "variant": "NORMAL",
              "visible": true,
              "dimension": false,
              "metric": true,
              "predefinedContainer": {
                "filters": [],
                "containers": [],
                "combined": false
              },
              "alias": "predefined_formula_avg_visit_duration|0",
              "inTimeSeries": false,
              "chart": {
                "visible": false,
                "yAxis": "0"
              },
              "sumValue": false,
              "predefinedSegmentConnections": [],
              "columnPeriod": "ANALYSIS",
              "round": "2",
              "roundConfig": {
                "override": false,
                "round": "2"
              }
            },
            {
              "arrangeType": "predefined_formula_bounce_rate",
              "dataType": "NUMBER",
              "title": "Bounce Rate %",
              "metricDisplayType": "DISTRIBUTION",
              "dataVisual": "TRAFFIC_LIGHT",
              "dataVisualTarget": "MIN",
              "dataVisualTargetMax": "auto",
              "dataVisualTargetMin": "auto",
              "scope": "OBJECT",
              "variant": "NORMAL",
              "visible": true,
              "dimension": false,
              "metric": true,
              "predefinedContainer": {
                "filters": [],
                "containers": [],
                "combined": false
              },
              "alias": "predefined_formula_bounce_rate|0",
              "inTimeSeries": false,
              "chart": {
                "visible": true,
                "yAxis": "1"
              },
              "sumValue": false,
              "predefinedSegmentConnections": [],
              "columnPeriod": "ANALYSIS",
              "round": "2",
              "roundConfig": {
                "override": false,
                "round": "2"
              }
            }
          ],
          "variant": "LIST",
          "standardChart": "LINE",
          "showTable": true,
          "showPic": true,
          "forbidChart": false,
          "viewMode": {
            "standard": {
              "pivotState": [],
              "sankeyConfig": {
                "reverse": false,
                "pathLength": "5",
                "chartState": []
              }
            },
            "timeSeries": {
              "timeArrangeType": "time_id_categories_t_year_week",
              "values": [],
              "top": "3",
              "viewType": "values"
            },
            "comparison": {
              "type": "time",
              "sorting": {
                "time": [],
                "segment": []
              },
              "values": {
                "time": [],
                "segment": []
              },
              "collapsed": {},
              "primaryChangeType": {}
            },
            "path": {
              "reverse": false,
              "metricArrangeType": "",
              "dimensionContext": "NONE",
              "pathLength": "5",
              "distinct": true,
              "chartState": []
            },
            "crossTable": {
              "metricArrangeType": "",
              "metricSortDirection": "DESCENDING",
              "crossDimensionSortDirection": "",
              "mainDimensionSortDirection": "",
              "dimensionUpperLimit": "10",
              "crossDimensionArrangeType": ""
            }
          }
        }
      }
    ],
    "showInMenu": true,
    "predefined": false,
    "creatorSSOUserId": "7",
    "modifierSSOUserId": "7",
    "creationTime": "2020-11-11T07:06:55+0000",
    "modificationTime": "2021-12-17T09:48:24+0000",
    "showContent": true,
    "gridColumns": "0",
    "publicReport": false,
    "startDialogConfigurable": true,
    "startDialogEnabled": false,
    "quickFilters": [
      {
        "arrangeType": "custom_paras_session_generic42",
        "connector": "AND",
        "filterPredicate": "LIKE",
        "value1": "",
        "value2": "",
        "context": "NONE",
        "caseSensitive": false,
        "intern": false,
        "numberOfDays": "0"
      }
    ],
    "dashboardQuickFiltersCollapsed": false,
    "dashboardQuickFilterValues": {
      "custom_paras_session_generic42": {
        "configurable": true,
        "values": []
      }
    },
    "categories": [],
    "autoRefresh": false
  }
}
Expand All
object
id
integer (int64)

Id

elementIds
Array of integer
integer (int64)

Element Ids

configuration
object (Report)
id
integer (int32)

Report Id

title
string
description
string
reportElements
Array of object (ReportElement)

Array of columns

object
id
integer (int32)

ID of the element

reportId
integer (int32)

ID of the report

type
string

Type of the element for eg. Analysis, KPI, Sparkline

configJson
object

Different type of queries are possible

OneOf
TableQuery
object (TableQuery)
columns
Array of object Required

Array of columns

object
name
string
sortDirection
string

Possible sorting directions

Valid values[ "ASCENDING", "DESCENDING" ]
sortIndex
integer

Indicates order of sorting when there is more than one sorting column. (starting from 0).

lowerLimit
integer
upperLimit
integer
inTimeSeries
boolean

Optional property indicating if a column will be used in time series view mode; defaults to false. Can be omitted if it's value is not set to true.

columnPeriod
string

Indicates which Time range must be used for the column. ANALYSIS: uses the analysis time range. COLUMN: uses the time filter defined inside the column. ELEMENT: uses the time filter defined inside the element configuration - i.e. custom metric/formula

Valid values[ "ANALYSIS", "COLUMN", "ELEMENT" ]
scope
string
Valid values[ "OBJECT", "NONE" ]
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
predefinedContainer
object (Container)
filters
Array of object (Filter)

Array of filters

object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
containers
Array of object (Container)

array of containers (recursion)

object Recursive
connector
string

Connectors

Valid values[ "AND", "OR" ]
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
type
string

Indicates how filters must be applied. TIME_ORDER is sequential, NORMAL not

Valid values[ "NORMAL", "TIME_ORDER" ]
inOrNotIn
string
Valid values[ "IN", "NOT_IN" ]
variant
string Required

Type of Data Structure

Valid values[ "LIST", "PIVOT", "PIVOT_AS_LIST", "COMPARISON" ]
predefinedContainer
object (Container) Required
filters
Array of object (Filter)

Array of filters

object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
containers
Array of object (Container)

array of containers (recursion)

object Recursive
connector
string

Connectors

Valid values[ "AND", "OR" ]
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
type
string

Indicates how filters must be applied. TIME_ORDER is sequential, NORMAL not

Valid values[ "NORMAL", "TIME_ORDER" ]
inOrNotIn
string
Valid values[ "IN", "NOT_IN" ]
predefinedSegmentConnections
Array of object (Filter)
object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
viewMode
object (ViewMode)
active
string
Valid values[ "comparison", "timeSeries", "path", "crossTable" ]
comparison
object
type
string

type of comparison. It can be either on time or segment. The corresponding properties must be filled accordingly in values and sorting

Valid values[ "time", "segment" ]
values
object
time
Array of object (Filter)
object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
segment
Array of object (SegmentContainer)
object
segmentID
string

ID of the Segment

connectorPredicate
string
inOrNotInPredicate
string
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
position
integer

Indicates segment ordering in case of several Segment

sorting
object
time
Array of object (ViewModeComparisonSortingItem)
object

Sorting of comparison

alias
string

alias of the column being sorted

direction
string

Possible sorting directions

Valid values[ "ASCENDING", "DESCENDING" ]
segment
Array of object (ViewModeComparisonSortingItem)
object

Sorting of comparison

alias
string

alias of the column being sorted

direction
string

Possible sorting directions

Valid values[ "ASCENDING", "DESCENDING" ]
timeSeries
object
timeName
string

The name of the time dimension used in the time series - i.e. "time_days" for days.

viewType
string

The type of the time series view mode. Set "top" for time series of the top "x" number of objects. Set "values" based on specific object values populated in the values list of this configuration.

Valid values[ "top", "values" ]
top
integer

The number of top objects the time series is build upon.

values
Array of string

A list of object values - i.e. ["Seach", "Cart", "Home"] for object "pages".

string
path
object
metricName
string

The name of the metric used in the path analysis - i.e. "visits".

dimensionContext
string

The context in which the dimension for the path analysis is evaluated.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
reverse
boolean

Whether the path analysis should be performed in reverse order.

distinct
boolean

Whether to count only unique paths in the analysis.

pathLength
integer

The maximum number of steps to include in the path analysis.

crossTable
object
metricName
string

The name of the metric used for values in the cross table analysis - i.e. "pages_pageImpressions".

crossDimensionName
string

The name of the dimension used for the cross-analysis - i.e. "browser_fullName".

mainDimensionSortDirection
string

Sort direction for the main dimension.

Valid values[ "ASCENDING", "DESCENDING", "" ]
metricSortDirection
string

Sort direction for the metric values.

Valid values[ "ASCENDING", "DESCENDING", "" ]
dimensionUpperLimit
integer

The maximum number of dimension values to include in the analysis.

crossDimensionSortDirection
string

Sort direction for the cross dimension.

Valid values[ "ASCENDING", "DESCENDING", "" ]
KpiQuery
object (KpiQuery)
elementPeriod
string

One of the following periods should be used:

  • ELEMENT: when the time filter is either inherited from the report or the time filter configured in the report element configuration.
  • MONAD: when the time filter is inherited from the custom metric configuration.
Valid values[ "ELEMENT", "MONAD" ]
type
string

Type of the query

Valid values[ "KPI", "SPARKLINE" ]
metricName
string

name of the metric of the KPI

dimensionName
string

name of the dimension of the KPI

comparison
object (Comparison)

Comparison definition

type
string

Type of comparison

Valid values[ "NONE", "PERIOD", "LIMIT", "SLIDING_WINDOW" ]
slidingWindowWeekdayAdjust
boolean
slidingWindowTimeShift
string
Valid values[ "PRECEDING", "PREVIOUS_MONTH", "PREVIOUS_QUARTER", "PREVIOUS_YEAR" ]
filter
object (Filter)
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
predefinedContainer
object (Container)
filters
Array of object (Filter)

Array of filters

object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
containers
Array of object (Container)

array of containers (recursion)

object Recursive
connector
string

Connectors

Valid values[ "AND", "OR" ]
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
type
string

Indicates how filters must be applied. TIME_ORDER is sequential, NORMAL not

Valid values[ "NORMAL", "TIME_ORDER" ]
inOrNotIn
string
Valid values[ "IN", "NOT_IN" ]
predefinedSegmentConnections
Array of object (Filter)
object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
timeFilter
object (Filter)
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
quickFilters
Array of object (Filter)
object
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
timeFilter
object (Filter)
name
string

Name of the Metric or Dimension being filtered.

filterPredicate
string

Filter predicates

Valid values[ "EQUAL", "UNEQUAL", "LESS", "LESSEQUAL", "GREATER", "GREATEREQUAL", "BETWEEN", "LIKE", "NOT_LIKE" ]
connector
string

Connectors

Valid values[ "AND", "OR" ]
caseSensitive
boolean
context
string

Context to evaluate the metric/dimension. If context property is not given or empty the default context of the object will be used. The default context can be identified from the context property in the response list of /query-objects.

Valid values[ "VISITOR", "SESSION", "PAGE", "ACTION", "ATOMIC", "NONE" ]
intern
boolean

Indicates if filter should be prioritized (Advanced).

Defaultfalse
value1
string
value2
string
values1
Array of string

Array of values

string
values2
Array of string

Array of values

string
Responses
200

OK

Expand All
object
reportCorrelationId
string

Correlation Id of the report

status
string

Status of the report after complete analysis

details
object (ReportQueryStateDetails)
lastUpdatedAt
string (date-time)

Last updated time of report

reportId
string

Report Unique Id

reportTitle
string

Report Name

queryStates
Array of object (QueryState)

List of query state of all caculation queries

object
accountId
string

Id of the account

correlationId
string

ID of the query

calculationId
string

Id of the calculated data

resultUrl
string

Link to get analysis data

status
string

Analysis query state

Valid values[ "SUCCESS", "FAILED", "ABORTED", "RUNNING", "INITIATED" ]
details
object
lastUpdatedAt
number

Last update time in milliseconds since the UNIX epoch

reportElementId
number

ID of the report element

400

Bad Request

Expand All
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

Not Found

Expand All
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

422

Unprocessable Entity

object
500

Internal Server Error

Expand All
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