How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Visier Personalized Alerts API

Manage your personalized alerts in Visier. Alerts notify you if a metric exceeds your defined threshold.**Note:** This API is in **alpha**. While in alpha, APIs may change in a breaking way without notice; functionality may be removed, and no deprecation notices will be issued.If you are interested in using this API, please contact your Customer Success Manager (CSM).

Visier Personalized Alerts API is one of 51 APIs that Visier publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include PersonalizedAlerts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 7 operations across 4 paths, and defines 60 schemas. It is described by OpenAPI 3.2.0, at version 22222222.99201.3040.

Requests are made against the base URL https://{vanity_name}.api.visier.io.

7 operations 4 paths 60 schemas 1 DELETE3 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
22222222.99201.3040
Base URL
https://{vanity_name}.api.visier.io
Authentication
API Key, API Key, HTTP Bearer, OAuth 2.0
Resource Areas
1

Authentication & Security 4

Visier Personalized Alerts API declares 4 security schemes for authenticating requests. An API key is passed in the cookie as VisierASIDToken (CookieAuth). An API key is passed in the header as apikey (ApiKeyAuth). It accepts HTTP bearer tokens (BearerAuth). It supports OAuth 2.0 (OAuth2Auth) using the authorizationCode and password flows, exposing 2 scopes. By default, every request must be authenticated.

Paths & Operations 7

Across 4 paths, the API surfaces 7 operations — 1 DELETE, 3 GET, 1 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

PersonalizedAlerts 7

Manage your personalized alerts in Visier. Alerts notify you if a metric exceeds your defined threshold. Note: This API is in alpha. While in alpha, APIs may change in a breaking…

GET
/v1alpha/alerts
Retrieve personalized alerts
PersonalizedAlerts_GetAlerts → default200
POST
/v1alpha/alerts
Create a personalized alert
PersonalizedAlerts_CreateAlert body → default200
GET
/v1alpha/alerts/{alertId}
Retrieve a personalized alert
PersonalizedAlerts_GetAlert 1 param → default200
PUT
/v1alpha/alerts/{alertId}
Update a personalized alert
PersonalizedAlerts_UpdateAlert 1 param body → default200
DELETE
/v1alpha/alerts/{alertId}
Delete a personalized alert
PersonalizedAlerts_DeleteAlert 1 param → default200
PUT
/v1alpha/alerts/{alertId}/recipient-status
Enable or disable a personalized alert
PersonalizedAlerts_UpdateRecipientStatus 1 param body → default200
GET
/v1alpha/notifications
Retrieve personalized alerts notifications
PersonalizedAlerts_GetNotifications → default200

Schemas 60

The contract defines 60 schemas that model the data the API accepts and returns. The most detailed are platform.FilterDTO (7 properties), platform.GroupedMetricValueThresholdCriteriaDTO (6 properties), platform.EventAlertDTO (6 properties), platform.EventAlertNotificationResultDTO (6 properties). Each schema is shown below with its type and property counts.

platform.EventAlertRelatedContentDTO
object
1 property
platform.ComparedMetricDTO
object
Whether to trigger the alert when the metric value is compared to a time period, another metric, or a group.
4 properties
platform.MemberValuesDTO
object
Member filter values are discrete member references in a dimension filter. You can define included and excluded members simultaneously. This is typically done…
2 properties
platform.CreateEventAlertRequestDTO
object
The details of the personalized alert to create.
3 properties
platform.RelativeTimeShiftDTO
object
2 properties
platform.EventAlertRelatedAnalysisDTO
object
2 properties
platform.EventAlertTriggerCriteriaDTO
object
The conditions on which to trigger the personalized alert.
1 property
platform.SameMetricOtherTimeDTO
object
Compare the metric against a time period; for example, the previous period or the same period of the previous year.
1 property
platform.DimensionReferenceDTO
object
The name and qualifying path of a dimension to query.
2 properties
platform.TriggerCriteriaResultInfoDTO
object
Information about the evaluated metric value.
2 properties
platform.UpdateEventAlertRecipientStatusDTO
object
1 property
platform.BetweenRuleDTO
object
The alert triggers if the metric value is between two defined values.
2 properties
platform.EventAlertNotificationResultsDTO
object
The notifications that have triggered for the user.
1 property
platform.TimeHandlingDTO
object
The time handling settings for a metric, which can be either per period or trailing periods.
2 properties
platform.FixedTimeTypeDTO
object
Compare against a fixed time period.
3 properties
platform.EventAlertNotificationResultDTO
object
A notification that has triggered for the user.
6 properties
platform.MetricFilterParameterValueDTO
object
The filter values of a metric parameter, including the parameter ID and the filters on the parameter
2 properties
platform.NumericRangeFilterDTO
object
A filter that uses a numeric range.
3 properties
platform.TriggerCriteriaMemberResultInfoDTO
object
The metric value by member ID, display name, and value.
4 properties
platform.RelativeTimeSelectionDTO
object
3 properties
platform.PreviousPeriodTimeTypeDTO
object
Compare against the previous period.
platform.EventAlertNotificationResultAlertDetailsDTO
object
Information about the alert notification that triggered.
2 properties
platform.KeyGroupFilterDTO
object
A filter that uses a key group in Visier.
2 properties
platform.EventAlertDeleteSuccessDTO
object
The alert that was successfully deleted.
1 property
platform.VersionedPlanParameterValueDTO
object
The value for a parameter on a planning metric, including the parameter ID and the versioned plan the parameter is based on.
3 properties
platform.FilterDTO
object
A filter selects specific data points within a population.
7 properties
platform.SameMetricOtherContextDTO
object
Compare the metric against a group; for example, High Performers.
1 property
platform.GetEventAlertsResponseDTO
object
The personalized alerts the user has access to.
2 properties
platform.RuleSetDTO
object
2 properties
platform.ConceptReferenceFilterDTO
object
A filter that uses a reference to a concept in Visier.
2 properties
platform.SameMetricDTO
object
Do not compare the metric value to anything but its own value.
platform.NumericRangeDTO
object
A numeric range.
3 properties
platform.TimePeriodDTO
object
A time period can define a specific interval of time or relative time period.
5 properties
platform.MetricDTO
object
The information of a metric.
3 properties
platform.SubjectMemberSetParameterValueDTO
object
The value for a metric subject member set parameter.
3 properties
platform.DimensionMemberReferenceDTO
object
The members of a dimension.
2 properties
platform.PersistedCohortFilterDTO
object
A filter that uses a persisted cohort in Visier.
2 properties
platform.AggregationTypeParameterValueDTO
object
The value for an aggregation parameter.
2 properties
platform.RuleDTO
object
The value to evaluate the metric value against.
2 properties
platform.SamePeriodPreviousYearTimeTypeDTO
object
Compare against the same period in the previous year.
platform.RelativeToRuleDTO
object
The alert triggers if the metric value meets the defined value threshold.
2 properties
platform.MemberSetParameterSelectionsDTO
object
1 property
platform.TimePeriodFilterDTO
object
A filter that uses a time period.
3 properties
platform.SelectionConceptReferenceDTO
object
The name and qualifying path of a selection concept to query.
2 properties
platform.MemberSetParameterSelectionDTO
object
2 properties
Status
object
The response structure for errors.
5 properties
platform.TriggerCriteriaOverallResultInfoDTO
object
The metric value.
2 properties
platform.PresetMemberSetSelectionDTO
object
2 properties
platform.TimePeriodMetadataDTO
object
The information of a time period.
3 properties
platform.ParameterDefinitionDTO
object
The information of a metric parameter value.
6 properties
platform.RelativeTimeExpressionDTO
object
3 properties
platform.RelativeTimePeriodDTO
object
A relative time period defines a series of time intervals to query, including the period type, period count, and time direction.
4 properties
platform.EventAlertDTO
object
A personalized alert's details, such as its ID and trigger criteria.
6 properties
platform.GroupedMetricValueThresholdCriteriaDTO
object
The metric threshold criteria on which to trigger the alert.
6 properties
platform.OtherMetricDTO
object
Compare the metric against a different metric; for example, a Visier Benchmarks metric.
1 property
platform.PeriodsBackDTO
object
The information of the periods back for a metric, including the period type and the number of periods back.
2 properties
platform.NumericParameterValueDTO
object
The value of a numeric parameter, including the parameter ID and the numeric value passed into the parameter.
2 properties
platform.MemberFilterDTO
object
Member filters are dimension member values to filter by in your query. The member filters are defined within the filters section of a query definition. You can…
2 properties
platform.CustomMemberSetSelectionDTO
object
2 properties
platform.PlanParameterValueDTO
object
The value for a parameter on a planning metric, including the parameter ID and the plan the parameter is based on.
5 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

visier-personalizedalerts-api-openapi.yml Raw ↑

Other APIs Visier publishes across the network.

Visier Query MCP Server
Visier Analytic Objects V2 API
Visier Basic Authentication API
Visier Benchmarks API
Visier Concepts V2 API
Visier Consolidated Analytics API
Visier Data And Job Handling API
Visier Data Export Connectors API API
Visier Data Intake API
Visier Data Model API
Visier Data Query API
Visier Data Upload API
Where this information came from

This is an independent, third-party profile of Visier Personalized Alerts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.