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.
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 |
|---|---|---|
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 Using the Segments page. | blacklist | whitelist. Volume drops apply to all segments if not defined | |
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 Using the Segments page. | Sample value: 1,2,3Volume 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 |
You can list/edit configurations for your organizations by API.
It is much easier to edit configurations through the UI when available.
get
https://api.mediarithmics.com
/v1/alert_type_configs
Get all configurations set up for an organisation
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.
Parameters
Query
organisation_id*
Int
ID of the organisation
Responses
200: OK
401: Unauthorized
post
https://api.mediarithmics.com
/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType
Creates a new configuration entry
Parameters
Path
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
Body
config_value*
string
The value of the configuration. Use the list of allowed configurations for the correct value format, depending on your configuration.
Responses
200: OK
400: Bad Request
Wrong parameter or the configuration already exists
401: Unauthorized
put
https://api.mediarithmics.com
/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType
Change the value or archive a configuration
Parameters
Path
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
Body
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
true to archive a configuration. false to reactivate it. For more information, see Archived configurations.Responses
200: OK
400: Bad Request
401: Unauthorized
404: Not Found
delete
https://api.mediarithmics.com
/v1/alert_type_configs/config_key=:configKey/organisation_id=:organisationId/alert_type=:alertType
Deletes a config
Parameters
Path
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
Responses
200: OK
400: Bad Request
404: Not Found
401: Unauthorized
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.
Last modified 4d ago