List all available dynamic timefilters
  • 3 Minutes to read
  • Dark
    Light

List all available dynamic timefilters

  • Dark
    Light

Article summary

Get
/dynamic-timefilters

List all available dynamic timefilter value.

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

OK

DynamicTimeFilters
[
  {
    "title": "Today",
    "name": "today",
    "dynamicFilter": {
      "name": "time_dynamic",
      "connector": "AND",
      "filterPredicate": "LIKE",
      "value1": "today",
      "value2": "",
      "context": "NONE"
    }
  },
  {
    "title": "Today, 7 days ago",
    "name": "before_7_days",
    "dynamicFilter": {
      "name": "time_dynamic",
      "connector": "AND",
      "filterPredicate": "LIKE",
      "value1": "before_7_days",
      "value2": "",
      "context": "NONE"
    }
  },
  {
    "title": "Today, 14 days ago",
    "name": "before_14_days",
    "dynamicFilter": {
      "name": "time_dynamic",
      "connector": "AND",
      "filterPredicate": "LIKE",
      "value1": "before_14_days",
      "value2": "",
      "context": "NONE"
    }
  }
]
Expand All
object

Dynamic Time Filter

title
string

Human readable description of the dynamic time filter (localized)

name
string

API name of the filter value

dynamicFilter
object

Snippet code which can be used in analysis

name
string

API Name of the filtered dimension

filterPredicate
string

Filter predicates

Valid values[ "\"EQUAL\"", "\"UNEQUAL\"", "\"LESS\"", "\"LESSEQUAL\"", "\"GREATER\"", "\"GREATEREQUAL\"", "\"BETWEEN\"", "\"LIKE\"", "\"NOT_LIKE\"" ]
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\"" ]
value1
string

Value to be filtered on.

value2
string

Second value to be filtered on. Only relevant for BETWEEN.

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:

ErrorDescriptionRelevant parameters
UnmappedNameAt least one object name cannot be found.List of objects not found in names array.
PivotIncompatibleMetricMetric not usable in Pivot detected.List of incompatible Metrics in names array.
PivotIncompatibleDimensionDimension not usable in Pivot detected.List of incompatible Dimensions in names array.
AnalysisLogicalCubeMismatchAll Dimensions and Metrics are not compatible.List of incompatible objects in names array.
InvalidSortingCriteriaSorting is applied on a non-sortable object.List of invalid sorted objects in names array.
TimeFilterMissingEach query must have a minimum of one Time Filter.N/A
InvalidSegmentNoneContainerA 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:

WarningDescriptionRelevant parameters
FilterLogicalCubeMismatchAt least one filter is ignored due to incompatibily with Dimensions and Metrics used.List of incomptible filter objects in names array.
InvalidMetricContextMetric used in an invalid context.List of metric with invalid context in aliases array.
SortingEnforcedSorting criteria has been added automaticallyList of objects that were sorted automatically in aliases array.
NoSortingDefinedSorting criteria is required for some dimensions.List of dimensions requiring a sorting in names array.
SortingLimitExceeded3 sorting criteria are allowed. All additional sorting criteria have been omitted.List of columns ignored for sorting in aliases array.
SortingRemovedA requested sorting criteria has been removedList of objects that were removed automatically in aliases array.
TodayRemovedToday 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