Developer
User guidesDeveloper websiteHelp centerLog in
  • Welcome!
  • Organisations structure
    • Datamart
    • Users and roles
  • User points
    • User identifiers
      • Networks IDs
        • Device-based Network IDs
          • Custom Device ID integration
          • ID5
          • First ID
        • User-based Network IDs
          • Custom User ID integration
          • UTIQ martechpass
      • Accounts
      • Emails
      • Device identifiers
    • User activities and events
    • Compartments
    • User profiles
    • User segments
    • Hyper point & Quarantine
  • Data model
    • Defining your schema
    • Computed fields
      • Concepts
      • Setup
      • Development
      • Examples
  • Data ingestion
    • Real time user tracking
      • Website tracking
      • Mobile apps tracking
      • Ads exposure tracking
      • AMP tracking
      • Conversions tracking
      • Email views and clicks
      • Tracking API
      • Event rules
      • Activity analyzers
    • Bulk processing
      • Imports
        • User activities import
        • User profiles import
        • User choices import
        • Segments import
      • Deletions
        • User identifiers deletion
        • Device points deletion
        • User points deletion
      • User identifiers association
      • Integration batch
    • Activities analytics
    • Data warehouse
      • Preliminary setup
        • BigQuery
      • Create data warehouse
  • Querying your data
    • OTQL queries
    • OTQL examples
    • GraphQL queries
    • UserPoint API
    • User activities
    • Activities analytics queries
      • API Quickstart
      • Dimensions and metrics
      • Use cases
    • Funnel API
  • Alerting
    • Alert configurations
  • Data visualisation
    • Quickstart
    • Dashboards
    • Sections and cards
    • Charts
    • Datasets and data sources
      • Using a data file data source
    • Transformations
    • Filters
    • Cookbook
    • Reference
  • Advanced usages
    • Audience segmentation
      • Audience features
      • Segment builders
      • Audience segment metrics
      • Audience segment feed
        • Building new feeds
        • Monitoring a feed
        • Curated Audiences (SDA)
      • Edge segments
      • Cohort-based Lookalike
    • Contextual targeting
      • Setup
      • Activation
        • Google Ad Manager
        • Xandr (through prebid.js)
      • API documentation
    • Exporting your data
      • Query Exports
      • Datamart replication
    • Data privacy compliance
      • User choices
      • Cleaning rules
      • Exercise of user rights
      • Cookies
    • Campaigns
    • Automations
      • Email routers
      • Email renderers
      • Opt-in provider
      • Custom action plugins
      • Usage limits for automations
    • Plugins
      • Concepts
      • Creation & Deployment
      • Coding your plugin
      • Manage existing plugins
      • Layouts
      • Presets
      • Monitoring
      • Throttling
      • Batching (for external feeds)
    • Platform monitoring
      • Resources usage
        • Dimensions and metrics
      • Collection volumes
        • Dimensions and metrics
      • Events ingestion monitoring
        • Dimensions and metrics
    • Data Clean Room
      • Bunker
      • Clean room
  • Resources
    • Tutorial: Data Ingestion
      • Your first events
        • Add the mediarithmics tag
          • Getting the tag
          • Adding the tag
        • Send events using the tag
          • Adding event properties
          • Finding the UserEvent type in your schema
          • Matching your schema
          • Standard events
      • Your first bulk imports
        • API basics
          • Authentication
          • Your first API call
        • Send documents using the API
          • Requirements
          • Sending documents
    • Using our API
      • Authentication
    • Tools & libraries
      • mics CLI
      • JS Tag
      • Plugin SDK
    • Data cubes
      • Creating a report
      • Reference
Powered by GitBook
On this page
  • Allowed configurations
  • Accessing configurations
  • Get all configurations set up for an organisation
  • Creates a new configuration entry
  • Change the value or archive a configuration
  • Deletes a config
  • Archived configurations

Was this helpful?

Export as PDF
  1. Alerting

Alert configurations

Alert Configurations allow customization of settings for different alert types within the Alerting module.

Configurations are used to define specific behavior, thresholds, and rules associated with each alert type. They are dedicated resources.

Each alert type can have a different set of configurations. By configuring alert types, you can tailor the behavior of the alerts to meet specific requirements.

Alert configurations can be personalized for a specific organization. This means that each organization can have its own set of configuration values for the alert types. If a configuration is not set, a default value set by mediarithmics will be used.

Allowed configurations

Alert configurations are identified by combining three values: config_key, organisation_id, and alert_type. The config_key uniquely identifies a specific configuration setting, while the organisation_id and alert_type specify the organization and alert type to which the configuration belongs.

Here is a list of available configuration keys and their sample values:

config
config_value
Editable in the UI

blacklist | whitelist. Volume drops apply to all segments if not defined

Sample value: 1,2,3

Volume drops apply to all segments if not defined

volume_drops_threshold alert_type: SEGMENT_VOLUME_DROP Percentage of volume drop in a segment that triggers the alert.

Value is an integer such as 15. Defaults to 10

initial_loading_not_starting_hours_threshold

alert_type: SEGMENT_INITIAL_LOADING Threshold in hours after which an alert will be triggered if the initial loading hasn't started

Value is an integer & reprents a number of hours Defaults to 24

initial_loading_running_too_long_hours_threshold

alert_type: SEGMENT_INITIAL_LOADING Threshold in hours after which an alert will be triggered if the initial loading is taking more time than expected

Value is an integer & reprents a number of hours Defaults to 24

initial_loading_records_error_threshold

alert_type: SEGMENT_INITIAL_LOADING An alert will be triggered if the percentage of errors is above the one defined in this config.

Value is an integer. Defaults to 10

Accessing configurations

You can list/edit configurations for your organizations by API.

It is much easier to edit configurations through the UI when available.

Get all configurations set up for an organisation

GET https://api.mediarithmics.com/v1/alert_type_configs

If a configuration from the allowed list is not setup, it won't be returned by this call but fall back to the default platform value in usage.

Query Parameters

Name
Type
Description

organisation_id*

Int

ID of the organisation

Creates a new configuration entry

POST https://api.mediarithmics.com/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType

Path Parameters

Name
Type
Description

configKey*

string

Configuration key. Use the list of allowed configurations. Other keys won't have an impact.

organisationId*

string

ID of the organisation for which to create the configuration

alertType*

string

Request Body

Name
Type
Description

config_value*

string

The value of the configuration. Use the list of allowed configurations for the correct value format, depending on your configuration.

Change the value or archive a configuration

PUT https://api.mediarithmics.com/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType

Path Parameters

Name
Type
Description

configKey*

string

Configuration key. Use the list of allowed configurations. Other keys won't have an impact.

organisationId*

string

ID of the organisation for which to create the configuration

alertType*

string

Request Body

Name
Type
Description

config_value*

string

The value of the configuration. Use the list of allowed configurations for the correct value format, depending on your configuration.

archived

Boolean

Deletes a config

DELETE https://api.mediarithmics.com/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType

Path Parameters

Name
Type
Description

configKey*

string

Configuration key. Use the list of allowed configurations. Other keys won't have an impact.

organisationId*

string

ID of the organisation for which to create the configuration

alertType*

string

Archived configurations

Configurations can be archived using the PUT request. An archived configuration is not used anymore by the platform (fallback to default value) but is easier to reactivate later.

PreviousAlertingNextData visualisation

Last updated 1 year ago

Was this helpful?

volume_drops_segment_labels_mode: alert_type: SEGMENT_VOLUME_DROP Defines whether segment labels in volume_drops_segment_labels_ids config are whitelisted or blacklisted. To edit in the UI, go to alerts on the segment list. For more information, see .

volume_drops_segment_labels_ids: alert_type: SEGMENT_VOLUME_DROP List of segment labels that will or won't receive volume drop alerts depending on the volume_drops_segment_labels_mode configuration To edit in the UI, go to alerts on the segment list. For more information, see .

. Use the list of allowed configurations.

. Use the list of allowed configurations.

true to archive a configuration. false to reactivate it. For more information, see .

. Use the list of allowed configurations.

Using the Segments page
Using the Segments page
AlertType
AlertType
AlertType
Archived configurations