List all available dimensions and metrics

5 Minutes to read

Print
Share
Dark
Light

List all available dimensions and metrics

5 Minutes to read

Print
Share
Dark
Light

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/query-objects

List all available dimensions and metrics

Security

OAuth

FlowClient credentials

Token URLhttps://intelligence.eu.mapp.com/analytics/api/oauth/token

Scopes:

mapp.intelligence-apiUse intelligence APIs

Query parameters

language

string

Optional standard ISO-639-1 language code for translation (when applicable).

Only "de" and "en" supported for the moment.

Default is "en"

Responses

200

Query Objects

{
  "metrics": [
    {
      "name": "alexaRanking",
      "context": "NONE",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Alexa Ranking",
      "elementType": "DEFAULT_METRIC",
      "metricDisplayType": "NORMAL"
    },
    {
      "name": "attribution_1_order_qty",
      "context": "ACTION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Qty Orders (Attribution last session, external), Order",
      "elementType": "CAMPAIGNS_ATTRIBUTION",
      "metricDisplayType": "NORMAL"
    },
    {
      "name": "custom_metric_1000853",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Android Users (Segment)",
      "elementType": "CUSTOM_METRIC",
      "metricDisplayType": "NORMAL"
    },
    {
      "name": "media_chapter_1",
      "context": "ATOMIC",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Media Chapter 1",
      "elementType": "DEFAULT_METRIC",
      "metricDisplayType": "NORMAL"
    },
    {
      "name": "page_category_number_13_sum",
      "context": "NONE",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Social Metrics",
      "elementType": "CUSTOM_CATEGORY",
      "metricDisplayType": "NORMAL"
    },
    {
      "name": "products_viewed_qty",
      "context": "ATOMIC",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Qty Product Views",
      "elementType": "DEFAULT_METRIC",
      "metricDisplayType": "NORMAL"
    }
  ],
  "dimensions": [
    {
      "name": "attribution_1",
      "context": "NONE",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Attribution (last session, external) of Order",
      "elementType": "CAMPAIGNS_ATTRIBUTION",
      "mapping": {
        "": "No Filter",
        "*": "All"
      }
    },
    {
      "name": "attribution_2",
      "context": "NONE",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Attribution (multiple, external) of Order",
      "elementType": "CAMPAIGNS_ATTRIBUTION",
      "mapping": {
        "": "No Filter",
        "*": "All"
      }
    },
    {
      "name": "device_deviceClass",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "Device Class",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "PC / Laptop",
        "1": "Smartphone",
        "2": "Tablet",
        "3": "TV",
        "4": "Console",
        "5": "Smartwatch",
        "6": "E-Reader",
        "7": "Mediahub",
        "8": "other",
        "1000": "unknown",
        "": "No filter"
      }
    },
    {
      "name": "device_model",
      "context": "SESSION",
      "dataType": "STRING",
      "sortable": "false",
      "title": "Device Model",
      "elementType": "DEFAULT_DIMENSION"
    },
    {
      "name": "user_country",
      "context": "SESSION",
      "dataType": "STRING",
      "sortable": "false",
      "title": "URM - Country",
      "elementType": "DEFAULT_DIMENSION"
    },
    {
      "name": "user_gender",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "URM - Gender",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "unknown",
        "1": "Man",
        "2": "Woman",
        "": "No filter"
      }
    },
    {
      "name": "user_id",
      "context": "SESSION",
      "dataType": "STRING",
      "sortable": "false",
      "title": "URM - Visitor Id",
      "elementType": "DEFAULT_DIMENSION"
    },
    {
      "name": "user_lastVisit",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "URM - Last Visit",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "No",
        "1": "Yes",
        "": "No filter"
      }
    },
    {
      "name": "user_lastVisitWithPurchase",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "URM - Last Visit with a Purchase",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "No",
        "1": "Yes",
        "": "No filter"
      }
    },
    {
      "name": "user_macroStatus",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "URM - Customer Macro Status",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "unknown",
        "1": "Offsite",
        "2": "Onsite",
        "3": "Product view",
        "4": "Abandoned basket",
        "5": "Registration",
        "6": "New Customer",
        "7": "Returning buyer",
        "": "No filter"
      }
    },
    {
      "name": "visitors_newVsReturning",
      "context": "SESSION",
      "dataType": "NUMBER",
      "sortable": "true",
      "title": "New vs. Returning",
      "elementType": "DEFAULT_DIMENSION",
      "mapping": {
        "0": "Returning",
        "1": "New",
        "2": "Unknown",
        "": "No filter"
      }
    }
  ]
}

Expand All

object

metrics

Array of object (Metric)

List of available metrics

object

Description of a metric

name

string

API name of the metric

dataType

string

Type of data

Valid values[ "\"STRING\"", "\"NUMBER\"", "\"GENERIC\"" ]

title

string

Human readable name of the metric. Localized

elementType

string

Type of element

Valid values[ "\"CAMPAIGNS_ATTRIBUTION\"", "\"CUSTOM_CATEGORY\"", "\"CUSTOM_FORMULA\"", "\"CUSTOM_METRIC\"", "\"CUSTOM_PARAMETER\"", "\"CUSTOM_PROCESS\"", "\"CUSTOM_SOURCE\"", "\"CUSTOM_VISITOR_GROUPS_TRAFFIC\"", "\"CUSTOM_WEBSITE_GOALS\"", "\"DEFAULT_DIMENSION\"", "\"DEFAULT_METRIC\"", "\"PREDEFINED_FORMULA\"", "\"PREDEFINED_METRIC\"" ]

metricDisplayType

string

Indicate how the data should be displayed

Valid values[ "\"NORMAL\"", "\"TIME\"", "\"CURRENCY\"", "\"DISTRIBUTION\"", "\"COMPARE\"" ]

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\"" ]

sortable

boolean

Indicates if object can be sorted.

dimensions

Array of object (Dimension)

List of available dimensions

object

Description of a Dimension element

name

string

API name of the dimension

dataType

string

Type of data

Valid values[ "\"STRING\"", "\"NUMBER\"", "\"GENERIC\"" ]

title

string

Human readable name of the metric. Localized

elementType

string

Type of element

context

string

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

mapping

object

Optional list of Mapping values

timeFormatPattern

string

Standard datetime pattern. Indicates that current STRING represents a Date

sortable

boolean

Indicates if object can be sorted.

403

No permission to execute operation

AnalysisNotFound

Invalid Token

{
  "title": "Invalid Token",
  "status": 403,
  "detail": "Token not valid",
  "statusCode": "INVALID_TOKEN"
}

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

Was this article helpful?

What's Next

List all available segments